summaryrefslogtreecommitdiff
path: root/TODO.md
blob: e0e6b14a1b20a711d8b27c7553899a6ffcc9ba0e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
# list of quick TODO tasks

this is temporary, frequently-updated, list of quick TODO that
don't warrant a 'Task' in itself.
Once done, move the task description to the 'Past Tasks' section


## Up-to-date Tasks list

In no particular order, they just need to be done:

  * A) each build_XXX build directory is generating its own build_XXX/src/generated/* assets and code.
       This is wrong and error-prone. There should be one source of truth
       for the generated assets/data/code at the top of the tree, under a common
       src/generated/ directory. Adapt all the code for that. Pay attention
       to tests (test_assets, e.g.) that *also* generate assets. They must§
       generate them in a throw-away directory.

  * B) make a pass of 'vertical compaction' for the code: there's a lot of
       superfluous '\n' empty lines in the code that shouldn't be here.
       Remove them to have a vertically more dense code. Use clang-format if needed.

  * C) add a top-level @README.md file with a short description of the
       project for new-comers, a one-line description of each .md files, and
       a quick layout and description of the source tree.

  * D) move all the non-essential .md files to a top-level doc/ directory
       (or any other more appropriate name) to remove the top-level file
       clutter. Keep ony the essential ones at top level. Update the git
       repo accordingly.

## Past Tasks

The past TODO are already done (stored here for archiving):