edited documentation so installation section reflects changes in dependency management package use
This commit is contained in:
23
README.md
23
README.md
@@ -2,31 +2,20 @@
|
|||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
Make sure you have `git`, `venv` and `pip` or `uv` installed. On GNU/Linux Debian-based distros with pre-installed `apt` package manager, the corresponding packages are:
|
Make sure you have `git`, `venv`, and `uv` installed. On GNU/Linux Debian-based distros with pre-installed `apt` package manager, the corresponding packages are:
|
||||||
|
|
||||||
- `git`
|
- `git`
|
||||||
- `python3-venv`
|
- `python3-venv`
|
||||||
- `python3-pip` (for installing `uv` instead, [follow this guide](https://docs.astral.sh/uv/getting-started/installation/))
|
- [Follow this guide](https://docs.astral.sh/uv/getting-started/installation/) for installing `uv`
|
||||||
|
|
||||||
Preferably, Ansible should also be installed on your system (see [this guide](https://docs.ansible.com/projects/ansible/latest/installation_guide/index.html)). Then, in your interactive bash shell session, run the following in order:
|
Ansible must also be installed on your system (see [this guide](https://docs.ansible.com/projects/ansible/latest/installation_guide/index.html)). Then, in your interactive bash shell session, run the following in order:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
git clone https://git.sukaato.moe/admin/skato-ansible.git
|
git clone https://git.sukaato.moe/admin/skato-ansible.git
|
||||||
cd ./skato-ansible
|
cd ./skato-ansible
|
||||||
python3 -m venv .env
|
uv venv .venv
|
||||||
source .env/bin/activate
|
uv sync
|
||||||
pip3 install -r ./requirements.txt
|
source .venv/bin/activate
|
||||||
ansible-galaxy collections install -r ./collections/requirements.yml
|
|
||||||
```
|
|
||||||
|
|
||||||
Or, if using `uv`, run these in order instead:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
git clone https://git.sukaato.moe/admin/skato-ansible.git
|
|
||||||
cd ./skato-ansible
|
|
||||||
uv venv .env
|
|
||||||
source .env/bin/activate
|
|
||||||
uv add -r ./requirements.txt
|
|
||||||
ansible-galaxy collections install -r ./collections/requirements.yml
|
ansible-galaxy collections install -r ./collections/requirements.yml
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user