Read-only mirrors. Development, issues and pull requests are on GitHub.

summaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
authorLeitwolf2026-11-16 14:49:23 +0300
committerGitHub2026-11-16 14:49:23 +0300
commit324048967d1fb198e3489b1722ca1ff317338550 (patch)
treee270ad6dc86200cc79cbdccfa1ef6de1da8aff0d /README.md
parent45c1bb14326cbee8fe57c6f639550e8eadd81f0a (diff)
parent4ee77681379619b3fab7b8b33446a67164216cc8 (diff)
downloadtazel.net-main.tar.gz
Merge pull request #10 from Progmasoft/content/new-tazelHEADmain
Rewrite the site for the Tazel of C, C++, Objective-C, Objective-C++ and Zig
Diffstat (limited to 'README.md')
-rw-r--r--README.md33
1 files changed, 13 insertions, 20 deletions
diff --git a/README.md b/README.md
index 43bed24..17d73ca 100644
--- a/README.md
+++ b/README.md
@@ -3,38 +3,31 @@
# tazel.net
-The site of [Tazel](https://github.com/Progmasoft/tazel), the build system and package manager of Tala, at
-[tazel.net](https://tazel.net/). It is a Nuxt site generated to static files, in English, German, Russian and Hebrew.
+The site of [Tazel](https://github.com/Progmasoft/tazel), the build system for C, C++, Objective-C, Objective-C++ and
+Zig, at [tazel.net](https://tazel.net/). It is a Nuxt site generated to static files, in English, German, Russian and
+French.
```bash
npm ci
npm run dev # http://localhost:3000
npm run generate # .output/public, every page in every language
npm run check # types
-npm test # the language helpers
+npm test # the language helpers and the translations
npm run format:check
```
## Content
-| Where | What |
-| ------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
-| `app/content/` | the words of the pages that are not documents: the frame, the home page, the site constants |
-| `content/<locale>/docs/` | the documentation as Markdown, one folder per language; the numbers order the tree |
-| `grammars/tala.tmLanguage.json` | the grammar that highlights Tala, from the [compiler repository](https://github.com/Progmasoft/tala/tree/main/Grammar) |
+| Where | What |
+| ------------------------ | ------------------------------------------------------------------------------------------- |
+| `app/content/` | the words of the pages that are not documents: the frame, the home page, the site constants |
+| `content/<locale>/docs/` | the documentation as Markdown, one folder per language; the numbers order the tree |
-The reference, under `content/en-US/docs/2.reference`, `3.extending` and `4.internals`, is copied from the
-`Documents/` of Tazel and is not edited here:
-
-```bash
-node scripts/sync-docs.mjs ../tazel
-```
-
-A page a language lacks is shown in English, with a note that says so. A release of Tazel changes
-`latestRelease` in `app/content/site.ts`.
+Every page exists in every language; `tests/translations.test.mjs` fails when one is missing. The documents describe
+what Tazel on its `main` branch does, and its examples are run with it. A release of Tazel changes `nextRelease` and
+`releaseNotes` in `app/content/site.ts`.
## Licence
-The code of the site is under AGPL-3.0-or-later with the Progmasoft Patent Grant 1.1; see [LICENSE.txt](LICENSE.txt),
-[PATENTS.md](PATENTS.md) and [NOTICE.txt](NOTICE.txt). The documents copied from Tazel and the Tala grammar keep their own
-licence, MPL-2.0 with the Progmasoft Exception 2.0, written at the top of each file or in the repository they come from.
+The code of the site is under AGPL-3.0-or-later; see [LICENSE.txt](LICENSE.txt) and [NOTICE.txt](NOTICE.txt).
+Progmasoft's own code is also covered by the [Progmasoft Patent Grant 1.1](PATENTS.md).