Update docs
This commit is contained in:
parent
e70a0584c9
commit
6ce1f7aff1
2 changed files with 7 additions and 29 deletions
|
|
@ -1,38 +1,16 @@
|
||||||
# Contributing
|
# Contributing
|
||||||
|
|
||||||
## TL;DR
|
## Windows development
|
||||||
|
|
||||||
### 1 Install system packages
|
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
sudo pacman -Syu --needed \
|
wsl --install
|
||||||
base-devel \
|
sudo apt update && sudo apt upgrade
|
||||||
git \
|
|
||||||
python \
|
|
||||||
uv \
|
|
||||||
sqlite \
|
|
||||||
curl \
|
|
||||||
wget \
|
|
||||||
openssh \
|
|
||||||
squashfs-tools \
|
|
||||||
e2fsprogs \
|
|
||||||
caddy \
|
|
||||||
podman
|
|
||||||
```
|
```
|
||||||
|
|
||||||
Notes:
|
## Commands
|
||||||
- `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
|
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
uv sync
|
uv sync
|
||||||
```
|
|
||||||
|
|
||||||
### 3 Day-to-day commands
|
|
||||||
|
|
||||||
```bash
|
|
||||||
uv run python manage.py check
|
uv run python manage.py check
|
||||||
uv run pytest -n 5 -q
|
uv run pytest -n 5 -q
|
||||||
uv run ruff check . --fix
|
uv run ruff check . --fix
|
||||||
|
|
|
||||||
|
|
@ -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.
|
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
|
Discord: TheLovinator#9276
|
||||||
|
|
||||||
# Contributing
|
## Contributing
|
||||||
|
|
||||||
See `CONTRIBUTING.md` for developer setup and workflow.
|
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.
|
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.
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue