Skip to content

Commit b2efc3e

Browse files
docs(README.md): Add reference to CONTRIBUTING, minor formatting
1 parent 6614399 commit b2efc3e

File tree

1 file changed

+13
-12
lines changed

1 file changed

+13
-12
lines changed

README.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -36,36 +36,37 @@ The task is to write an Object Pascal program which reads the file, calculates t
3636
```
3737

3838
## Entering The Challenge
39-
Submissions will be via a `PR`( Pull Request ) to this repository. \
39+
Submissions will be via a `PR` (Pull Request) to this repository.
4040
The challenge will run from the 10th of March until the 10th of May, 2024.
4141

4242
When creating your entry, please do as follows:
4343
1. Create a folder under `entries` with your first initial and last name, e.g., for Gustavo Carreno: `entries/gcarreno`.
4444
2. If you're worried about anonymity, because the Internet stinks, feel free to use a fictional one: Bruce Wayne, Clark Kent, James Logan, Peter Parker, Diana of Themyscira. Your pick!
4545
3. Create a `README.md` with some content about your approach, e.g., `entries/gcarreno/README.md`.
4646
4. Put all your code under `entries/<your name>/src`, e.g., `entries/gcarreno/src`.
47-
5. If you need to provide a custom `.gitignore` for something not present in the main one, please do.
47+
5. Send your binary to the `bin` folder off the root of this repository.
48+
6. If you need to provide a custom `.gitignore` for something not present in the main one, please do.
49+
7. Read the [CONTRIBUTING.md](./CONTRIBUTING.md) file for more details.
4850

4951
This challenge is mainly to allow us to learn something new. This means that copying code from others will be allowed, under these conditions:
5052
1. You can only use pure Object Pascal with no calls to any operating system's `API` or external `C/C++` libraries. \
51-
**There's been a bit of confusion about this restriction.** \
52-
To clear that out: You can use any package/custom code you want. \
53-
As long as it compiles cross-platform and itself is only pure Object Pascal. \
54-
Anything from the `Jedi Project` or even `mORMmot` ( or anything else ), if it compiles, runs cross-platform it's allowed.
53+
**There's been a bit of confusion about this restriction.**
54+
- To clear that out: You can use any package/custom code you want.
55+
- As long as it compiles cross-platform and itself is only pure Object Pascal.
56+
- Anything from the `Jedi Project` or even `mORMmot` ( or anything else ), if it compiles, runs cross-platform it's allowed.
5557
2. The code must have some sort of mention/attribution to the original author, in case you've used someone else's code.
5658
3. It's not a blatant copy just for the sake of submission.
5759
4. It adds something of value, not just a different code formatting.
5860
5. All code should be formatted with the `IDE`'s default formatting tool.
5961

60-
**IMPORTANT** \
61-
This challenge can be entered even if you only have access to the Community Edition of RAD Studio. \
62-
I have a Windows VM, with RAD Studio installed, that will do the necessary cross compilation into my Linux host.
62+
**IMPORTANT**
63+
This challenge can be entered even if you only have access to the Community Edition of RAD Studio. I have a Windows VM, with RAD Studio installed, that will do the necessary cross compilation into my Linux host.
6364

6465
Submit your implementation and become part of the leader board!
6566

6667
## Rounding
6768

68-
Székely Balázs has provided code for rounding towards positive infinity per the original challenge.\
69+
Székely Balázs has provided code for rounding towards positive infinity per the original challenge.
6970
This will be the official way to round the output values:
7071
```pas
7172
function TBaseline.RoundEx(x: Double): Double;
@@ -96,7 +97,7 @@ end;
9697
```
9798

9899
## Generating the measurements.txt
99-
> **NOTE** \
100+
> **NOTE**
100101
> We now have both a Lazarus version and a Delphi version of the generator for both 32b and 64b.
101102
102103
In order to produce the One Billion Rows of text, we are providing the [source code](./generator) for the official generator, so we all have the same entry data.
@@ -110,7 +111,7 @@ In order to produce the One Billion Rows of text, we are providing the [source c
110111
| **-n** or **--line-count \<number\>** | The amount of lines to be generated ( Can use 1_000_000_000 ) |
111112

112113
## Baseline
113-
> **NOTE** \
114+
> **NOTE**
114115
> This is still a bit in flux, still needing to get the Delphi version done.
115116
116117
In order to verify the official output, we are providing the [source code](./baseline) for the official baseline.

0 commit comments

Comments
 (0)