summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorMatthias Beyer <mail@beyermatthias.de>2021-05-17 13:25:22 +0200
committerMatthias Beyer <mail@beyermatthias.de>2021-05-17 13:25:22 +0200
commit715c34d2e22a4c837a6bc04a47fafe36e38b993a (patch)
tree5dfc6a807382e186913da964898d267ba50fc870 /README.md
parent194e3ea40c362a5acc431c0a6e19a53f33969ec8 (diff)
Add more detailed notes on how to setup butido
Signed-off-by: Matthias Beyer <mail@beyermatthias.de>
Diffstat (limited to 'README.md')
-rw-r--r--README.md39
1 files changed, 27 insertions, 12 deletions
diff --git a/README.md b/README.md
index 9f8be03..ccac97b 100644
--- a/README.md
+++ b/README.md
@@ -42,22 +42,37 @@ Building butido is easy, assuming you have a Rust installation:
cargo build --release # (remove --release for a debug build)
```
-Running is not so easy:
+Butido is built and tested with Rust 1.50.0 as MSRV.
-* Create a git repository
-* Put a `config.toml` file into the repository root, adapt parameters to your
- needs
-* Write `pkg.toml` files for your packages
-* Run a postgres instance somewhere
- * configure it to be accessible for butido with user and password
- * Setup tables (butido cannot do this yet)
-* Run docker instances somewhere, accessible via HTTP or socket
-Now you should be ready to try butido. butido takes `--help` in every subcommand
-to explain what it does.
+### (Development) Setup
+To set up a development infrastructure or a production infrastructure (using the
+examples from the `./examples/packages` directory):
-Butido is built and tested with Rust 1.50.0 as MSRV.
+```bash
+# pull down necessary docker images
+docker pull debian:bullseye
+docker pull postgres:12
+
+# setup the database in a postgres container
+PG_USER=pgdev \
+PG_PW=password \
+PG_DB=butido \
+PG_CONTAINER_NAME=butido-db \
+bash scripts/dev-pg-container.sh
+
+# copy the examples to /tmp
+cd examples/packages
+make
+
+# Finish the database setup
+cd /tmp/butido-test-repo
+/path/to/butido db setup
+
+# Start building
+/path/to/butido build a --image debian:bullseye
+```
### Glossary