tfld/watterblock
1
0
Fork 0
Code

update README

Browse Source
This commit is contained in:
Adrian Wannenmacher 2026-03-02 03:14:52 +01:00
parent 493daa1cff
commit 4ef0737f4f
Signed by: tfld
GPG Key ID: 19D986ECB1E492D5
1 changed files with 3 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -40,15 +40,11 @@ Structure
4. `models/` contains the "business logic", i.e. classes representing the current state and its 4. `models/` contains the "business logic", i.e. classes representing the current state and its
behaviour at runtime. behaviour at runtime.
5. `data/` contains components to store that state in persistent storage for later access. 5. `data/` contains components to store that state in persistent storage for later access.
6. `ui/` contains UI components. 6. `ui/` contains the user interface.
1. `ui/layout.js` is a layout component shared by all views, for a consistent shell.
2. `ui/views/` contains independent views, i.e. different "screens".
3. `ui/components/` contains individual components, which are parts of views, that can also be
reused.
7. `service-worker.js` is a ServiceWorker-Script, allowing for offline usage. 7. `service-worker.js` is a ServiceWorker-Script, allowing for offline usage.
8. `manifest.json` makes it possible to install the notepad as an app. 8. `manifest.json` makes it possible to install the notepad as an app.
9. `test.html` is a unit test runner, that runs the tests in `test.js`. That in turn loads tests 9. `test.html` loads and runs the unit tests from the various `*.test.js` files across the project.
from various `*.test.js` files from across the project. Those files are co-located with the stuff they contain tests for, to make them easier to manage.
10. `vendored/` contains copies of external dependencies, for direct use. 10. `vendored/` contains copies of external dependencies, for direct use.
Dependencies Dependencies