Skip to content

Commit

Permalink
documentation: improve README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Noki committed Dec 24, 2024
1 parent c9a0a42 commit 1729799
Showing 1 changed file with 18 additions and 5 deletions.
23 changes: 18 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,21 +10,35 @@ Maintainers can remotely upgrade sites without having to worry about wrong confi
## Getting Started

Using bbb-configs is quite simple. The TL;DR version for anyone not wanting to read the [FAQ](FAQ.md) is:
1. Install dependencies. Depending on your distro you might need to use a different package management system than `apt`.

### 1. Install dependencies

Depending on your distro you might need to use a different package management system than `apt`.

```sh
apt update
apt install -y jq
python3 -m venv venv
source venv/bin/activate
pip3 install -r requirements.txt
```
2. Generate images

### 2. Generate images

```sh
./generate-images.sh
```
or

or by passing location names as comma separated list

```sh
./generate-images.sh location1,location2,location3
```

or by passing a limit parameter that matches one or multiple hosts

```sh
ansible-playbook play.yml --limit location-* --tags image
ansible-playbook play.yml --limit location1-* --tags image
```

## How it Works
Expand Down Expand Up @@ -58,4 +72,3 @@ Wikiupdater expects an article or a redirect to the article at `wiki.freifunk.ne

* [Support Chat](https://matrix.to/#/#berlin.freifunk.net:matrix.org): Channel `#berlin.freifunk.net` on **matrix.org**.
* [Mailing List](https://lists.berlin.freifunk.net/cgi-bin/mailman/listinfo/berlin): For usage, support, discussions and hardware advise.

0 comments on commit 1729799

Please sign in to comment.