@@ -46,18 +46,36 @@ Tools (in this repo)
4646 * Automated test suite for incremental versions.
4747 * Run tests to assert that each project version outputted compiles (and maybe runs).
4848
49+ ### ` language_reference ` tool flow
4950``` mermaid
5051flowchart TD
5152
5253python.py --> make_ver.py
5354Java.java --> make_ver.py
5455rust.rs --> make_ver.py
5556csharp.cs --> make_ver.py
57+ ... --> make_ver.py
5658
5759make_ver.py --> api.py --> language_reference.json --> Browser
5860/static/language_reference.html --> Browser
5961```
6062
63+ ### ` <project>.json ` tool flow
64+ ``` mermaid
65+ flowchart TD
66+
67+ copter.ver.json --> make_ver.py
68+ copter.py --> make_ver.py
69+ copter.java --> make_ver.py
70+ ... --> make_ver.py
71+
72+ make_ver.py --> api.py --> copter.json --> Browser
73+ /static/projects.html --> Browser
74+
75+ copter.json --> verify_snippets
76+ ```
77+
78+
6179Example Versions
6280----------------
6381
@@ -83,7 +101,7 @@ System.out.println('hello'); // VER: output
83101
84102These versions are outputted to ` language_reference.json ` .
85103
86- The above ` language_reference.json ` is rendered by html/js to look something like the table below:
104+ The above ` language_reference.json ` is rendered by html/js ` /static/language_reference.html ` to look something like the table below:
87105
88106| | py | java |
89107| ----------| ----------------| ------------------------------|
@@ -110,10 +128,10 @@ Because projects are bigger and could contain further assets, projects are typic
110128* A folder is recursively crawled for all ` .ver ` files.
111129* For each ` NAME.ver ` file, all the languages that are loaded e.g. ` NAME.py ` +` NAME.java ` +` NAME.cs `
112130* A set of diff's are made for each version name incrementally (output to ` projects.json ` )
113- * A html/js viewer renders the diffs for each language
131+ * ` /static/projects.html ` A html/js viewer renders the diffs for each language
114132
115133
116- ` verify_snippets ` (for projects )
134+ ` verify_snippets ` (for ` project.json ` )
117135-----------------
118136
119137* There might be many incremental versions of a file (e.g. ` copter.xxx ` has 8 versions).
0 commit comments