Skip to content

Commit

Permalink
Add developer docs [skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
sasha0552 authored Sep 1, 2024
1 parent 6df8917 commit 12b3ed3
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 3 deletions.
3 changes: 0 additions & 3 deletions docs/README.md

This file was deleted.

35 changes: 35 additions & 0 deletions docs/maintenance.md
Original file line number Diff line number Diff line change
@@ -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).

0 comments on commit 12b3ed3

Please sign in to comment.