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

summaryrefslogtreecommitdiffhomepage
path: root/README.md
blob: 17d73ca68d2e7ec87848469a276b682eddb70d9a (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
<!-- SPDX-FileCopyrightText: 2026 Progmasoft <[email protected]> -->
<!-- SPDX-License-Identifier: AGPL-3.0-or-later -->

# tazel.net

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 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          |

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; 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).