Updated documentation, added tree-sitter experiment

This commit is contained in:
2026-04-17 00:50:00 +02:00
parent 376ca6d2f2
commit 8b7d99393d
4 changed files with 102 additions and 0 deletions

19
planning/to-document.md Normal file
View File

@@ -0,0 +1,19 @@
# Readme.md
In `readme.md` we should explain that `npm install` can be used both with and without development dependencies.
We are likely to want some development dependencies for the following purposes:
- Template processing
- Ecmascript parsing for inline rich semantic documentation
## Installing tree-sitter-javascript
- requires `node-gyp`
```sh
CXXFLAGS="-std=c++20" npm i -D tree-sitter tree-sitter-javascript
```
This section should be somewhat expanded - especially regarding node-gyp