docs: add warning and quick start section to README

This commit is contained in:
rzmk 2025-08-12 18:13:29 -04:00
parent c308756413
commit 5b3cd76ce7

View file

@ -1,6 +1,22 @@
# ckan-devstaller
`ckan-devstaller` attempts to install CKAN 2.11.3 from source, intended for development use in a new Ubuntu 22.04 instance.
`ckan-devstaller` attempts to install CKAN 2.11.3 from source using [ckan-compose](https://github.com/tino097/ckan-compose), intended for development use in a new Ubuntu 22.04 instance.
## Quick start
> [!WARNING]
> Make sure `ckan-devstaller` is run in a **new** Ubuntu 22.04 instance. Do NOT run `ckan-devstaller` in an existing instance that is important for your usage.
Paste this into your new Ubuntu 22.04 instance's terminal:
```bash
cd ~/
sudo apt update -y && sudo apt upgrade -y
sudo apt install curl -y
curl -LO https://github.com/dathere/ckan-devstaller/releases/download/0.1.0/ckan-devstaller
sudo chmod +x ./ckan-devstaller
./ckan-devstaller
```
<img width="1271" height="183" alt="{8479CBE1-788E-48B3-AE9C-F3A51724520C}" src="https://github.com/user-attachments/assets/86373a89-895b-403c-a699-0cf3865ee100" />