Update docs

This commit is contained in:
Joakim Hellsén 2026-05-01 04:55:25 +02:00
commit 6ce1f7aff1
Signed by: Joakim Hellsén
SSH key fingerprint: SHA256:/9h/CsExpFp+PRhsfA0xznFx2CGfTT5R/kpuFfUgEQk
2 changed files with 7 additions and 29 deletions

View file

@ -1,38 +1,16 @@
# Contributing
## TL;DR
### 1 Install system packages
## Windows development
```bash
sudo pacman -Syu --needed \
base-devel \
git \
python \
uv \
sqlite \
curl \
wget \
openssh \
squashfs-tools \
e2fsprogs \
caddy \
podman
wsl --install
sudo apt update && sudo apt upgrade
```
Notes:
- `uv` is package/dependency runner used by repo.
- `squashfs-tools`, `openssh`, and `e2fsprogs` are needed for `get_rootfs.bash` image prep flow.
### 2 Bootstrap project
## Commands
```bash
uv sync
```
### 3 Day-to-day commands
```bash
uv run python manage.py check
uv run pytest -n 5 -q
uv run ruff check . --fix

View file

@ -2,14 +2,14 @@
A platform to run and host applications, with a focus on Python applications. It provides an easy-to-use web interface for managing applications, as well as a powerful API for automation and integration.
Email: tlovinator@gmail.com
Email: <tlovinator@gmail.com>
Discord: TheLovinator#9276
# Contributing
## Contributing
See `CONTRIBUTING.md` for developer setup and workflow.
# License
## License
The AGPL license applies to the infrastructure platform (the SaaS backend, the deployment scripts, the web UI). It does not infect the user's code. If a tenant hosts a proprietary, closed-source application on this platform, their code remains completely theirs.