diff --git a/.github/workflows/UBUNTU_makefile.yml b/.github/workflows/UBUNTU_makefile.yml index 0d0b21a..689afed 100644 --- a/.github/workflows/UBUNTU_makefile.yml +++ b/.github/workflows/UBUNTU_makefile.yml @@ -18,4 +18,4 @@ jobs: run: make - name: Install man page - run: sudo make -C ./man_pages && make -C ./man_pages clean \ No newline at end of file + run: sudo make -C ./docs/man_pages && make -C ./docs/man_pages clean \ No newline at end of file diff --git a/docs/CLI_Timer_Session_format.md b/docs/CLI_Timer_Session_format.md new file mode 100644 index 0000000..6796d2e --- /dev/null +++ b/docs/CLI_Timer_Session_format.md @@ -0,0 +1,30 @@ +# Introduction + +This is the secification for the `*.CLI_T_S` file (new) binary format. +
+This is for version 1 of the file type. + +# Description + +## Metadata +Magic bytes: `CLI_TIMER{version_num}` (`43 4c 49 5f 54 49 4d 45 52 01`) +
+Then there will be the initial seed in binary so that `--seed` stays consistent. + +## Main body +In the original format it went `{scramble}ยง{time}~{Comment}`.
+If there were penalties (i.e. +2 or DNF) it would do `{time}+` or `DNF({time})`. +
+ +In this new version, it will instead be `[02]{scramble}[03]{penalty_num}{time}[02]{comment}[03]{rng_usage_count}`. + +This is where `[02]` and `[03]` are the ASCII codes for "start of text" and "end of text" respectively.
+The `{scramble}` and `{comment}` sections are just raw strings with no compression (for version 1; hopefully not for future versions).
+`{penalty_num}` will be:
+* 1: No penalty +* 2: +2 +* 3: DNF + +The `{time}` will be a binary representation for a float for the amount of seconds. For example, the time `1:23.45` would be stored as `42 a6 e6 66` + +Finally there will be the `{rng_usage_count}` so that when using a seed, it picks up where it left off. \ No newline at end of file diff --git a/man_pages/.gitignore b/docs/man_pages/.gitignore similarity index 100% rename from man_pages/.gitignore rename to docs/man_pages/.gitignore diff --git a/man_pages/CLI_Timer.1 b/docs/man_pages/CLI_Timer.1 similarity index 100% rename from man_pages/CLI_Timer.1 rename to docs/man_pages/CLI_Timer.1 diff --git a/man_pages/makefile b/docs/man_pages/makefile similarity index 100% rename from man_pages/makefile rename to docs/man_pages/makefile