halkyon-days/halkyon
Watch
1
0
Fork
You've already forked halkyon
 0
Code Issues Pull requests Projects Releases 37 Packages Wiki Activity Actions

docs: one repository for every app and shared package (ADR 0015)

Browse source 
The root AGENTS.md holds what applies to every app and package (how
work is done, Serverpod, checks with Melos and the tools, CI); Learn's
own is apps/learn/AGENTS.md, Todo's a note that it is still the
scaffold. The root README introduces the project, Learn's moves to its
folder; LICENSE.md says which licence covers which directory, Todo's
packages unlicensed until decided; one CONTRIBUTING.md. ADR 0015
records the decision; ADR 0014 and 0003 note what moved.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Signed-off-by: Tizian 「ティツィアーン」 <raisondetredev@pm.me>
This commit is contained in:
Tizian 「ティツィアーン」 2026-10-19 20:39:09 +02:00
commit 1b62c8098c
Signed by: raisondetredev
GPG key ID: 07F6FCF405488B64
1 changed files with 542 additions and 393 deletions
Download patch file Download diff file Expand all files Collapse all files

26
LICENSE.md
View file

@ -1,19 +1,25 @@
# Licences
Halkyon Learn's packages carry different licences:
The repository's packages carry different licences, each package's full text in its
`LICENSE` file:
| Package | Licence | SPDX |
|---|---|---|
| `halkyon_learn_flutter`, the app | GNU Affero General Public License, version 3 or any later version | `AGPL-3.0-or-later` |
| `halkyon_learn_client`, generated from our models | GNU Affero General Public License, version 3 or any later version | `AGPL-3.0-or-later` |
| `halkyon_learn_server` | Server Side Public License, version 1 | `SSPL-1.0` |
| `halkyon_learn_curator`, turning dictionary downloads into dictionary files | GNU Affero General Public License, version 3 or any later version | `AGPL-3.0-or-later` |
| `apps/learn/halkyon_learn_flutter`, Learn's app | GNU Affero General Public License, version 3 or any later version | `AGPL-3.0-or-later` |
| `apps/learn/halkyon_learn_client`, generated from Learn's models | GNU Affero General Public License, version 3 or any later version | `AGPL-3.0-or-later` |
| `apps/learn/halkyon_learn_server` | Server Side Public License, version 1 | `SSPL-1.0` |
| `apps/learn/halkyon_learn_curator`, turning dictionary downloads into dictionary files | GNU Affero General Public License, version 3 or any later version | `AGPL-3.0-or-later` |
| `packages/halkyon_base_server`, the Serverpod module every Halkyon server includes | Server Side Public License, version 1 | `SSPL-1.0` |
| `packages/halkyon_base_client`, generated from the module's models | GNU Affero General Public License, version 3 or any later version | `AGPL-3.0-or-later` |
| `packages/halkyon_app`, `packages/halkyon_ui` | GNU Affero General Public License, version 3 or any later version | `AGPL-3.0-or-later` |
| `packages/halkyon_core`, `packages/halkyon_interop` | GNU Affero General Public License, version 3 or any later version, as halkyon_shared, where they began, licensed them; their `LICENSE` files are still placeholders to be replaced with its text | `AGPL-3.0-or-later` |
| `apps/todo/*`, Halkyon Todo's scaffold | None yet: unlicensed until the developer decides | — |
Each package holds the full text in its `LICENSE` file. The server builds on
Serverpod's core, which is under the SSPL. The app links only BSD-3 packages, and the
client package is generated from our own model definitions, so both are under the AGPL.
The curator depends on neither the server nor Serverpod: the server reads the files it
writes, never its code.
The servers and the module build on Serverpod's core, which is under the SSPL, and so are
under it too. The apps and the shared Flutter packages link only permissively licensed
packages, and the client packages are generated from our own model definitions, so all of
them are under the AGPL. The curator depends on neither a server nor Serverpod: Learn's
server reads the files it writes, never its code.
Everything else in this repository (tooling, documentation, deployment files) is under
`AGPL-3.0-or-later` unless a file says otherwise.