From 6ce1f7aff1b1b66ab7936f0c8a42751fa41cfe79 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Joakim=20Hells=C3=A9n?= Date: Fri, 1 May 2026 04:55:25 +0200 Subject: [PATCH] Update docs --- CONTRIBUTING.md | 30 ++++-------------------------- README.md | 6 +++--- 2 files changed, 7 insertions(+), 29 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 94d8423..8b5e613 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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 diff --git a/README.md b/README.md index a5e5048..2d6cac5 100644 --- a/README.md +++ b/README.md @@ -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: 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.