From 12b3ed30f907be16aa39aaa075eff9f417bf8442 Mon Sep 17 00:00:00 2001 From: sasha0552 Date: Sun, 1 Sep 2024 11:09:50 +0000 Subject: [PATCH] Add developer docs [skip ci] --- docs/README.md | 3 --- docs/maintenance.md | 35 +++++++++++++++++++++++++++++++++++ 2 files changed, 35 insertions(+), 3 deletions(-) delete mode 100644 docs/README.md create mode 100644 docs/maintenance.md diff --git a/docs/README.md b/docs/README.md deleted file mode 100644 index 05a4f59..0000000 --- a/docs/README.md +++ /dev/null @@ -1,3 +0,0 @@ -# ToriLinux Documentation - -TODO diff --git a/docs/maintenance.md b/docs/maintenance.md new file mode 100644 index 0000000..61379d1 --- /dev/null +++ b/docs/maintenance.md @@ -0,0 +1,35 @@ +# ToriLinux maintenance (developer documentation) + +## Working with projects + +### Update project versions + +You can use `.ci/update.py` to update project versions. + +### Add/modify/delete a project + +You can add/remove/modify the script(s) in `airootfs/root/customize_airootfs/scripts`. + +For now, you can use other scripts for reference. + +Use `.ci/configure.py [cuda|rocm] [gui|normal]` to render these templates. + +## Working with CI + +Modify any of the templates in `.ci/templates/` or `.ci/actions.py`. + +Use `.ci/actions.py` to regenerate CI workflows in `.github/actions/`. + +## Build locally + +You need ArchLinux or at least any linux distribution that supports Docker (you can use a Docker image of ArchLinux). + +Install the dependencies listed in the `.ci/dependencies.sh` file. + +Render the scripts using `.ci/configure.py [cuda|rocm] [gui|normal]`. + +Optionally, you can run `.ci/empty.sh` after `.ci/configure.py` to create an empty image. + +Run `mkarchiso -v -m iso -w /some/temporary/directory -o /some/output/directory .` to build the image. + +Preferably use tmpfs (e.g., `/tmp/mkarchiso`) for the temporary directory (note that you need more than 50 GB of free space in that directory).