diff options
author | Santo Cariotti <santo@dcariotti.me> | 2024-09-11 17:06:32 +0200 |
---|---|---|
committer | Santo Cariotti <santo@dcariotti.me> | 2024-09-11 17:06:32 +0200 |
commit | 48a0c0f007bff5df95c69b727e3ee0e6c3b9bfeb (patch) | |
tree | c5f3db4f784b2a7c29b271abe7ab42466551669d | |
parent | 530a29fc2768e6f6a574b71c42bf69c20d8a160a (diff) |
doc: Show readme.md in main.rs file
-rw-r--r-- | README.md | 12 | ||||
-rw-r--r-- | src/main.rs | 1 |
2 files changed, 7 insertions, 6 deletions
@@ -33,7 +33,7 @@ After that you must copy the `schema/init.sql` file into the database. Now just run the app -``` +```text cargo run ``` @@ -44,19 +44,19 @@ pushes the latest release version to a [GHCR.io package](https://github.com/cas- A new version is released using -``` +```text ./scripts/release X.Y.Z ``` Now you just exec -``` +```text docker pull ghcr.io/cas-4/backend:latest ``` Or you can build a new image -``` +```text docker build -t cas:latest . docker run \ -e RUST_LOG=... \ @@ -69,7 +69,7 @@ docker run \ Or the Docker compose which puts up also the PostgreSQL locally. -``` +```text docker compose up ``` @@ -78,7 +78,7 @@ docker compose up If you do not want to use Docker or Docker compose directly, you can use a Kubernetes cluster like [MiniKube](https://minikube.sigs.k8s.io/docs/). -``` +```text ./scripts/k8s (apply|delete) ``` diff --git a/src/main.rs b/src/main.rs index 6988711..33718c1 100644 --- a/src/main.rs +++ b/src/main.rs @@ -1,3 +1,4 @@ +#![doc = include_str!("../README.md")] mod config; mod db; mod errors; |