From c7ae1e103f7ee05255ef2b5018e3cfecdd6b8b02 Mon Sep 17 00:00:00 2001 From: Fuwn Date: Tue, 19 Dec 2023 03:56:48 +0000 Subject: docs(readme): move deployment steps up --- README.md | 35 +++++++++++++++++++++-------------- 1 file changed, 21 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 8bbfeb9..daba939 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,27 @@ has Gemini support. ## Usage +### Docker Compose + +A Docker Compose file is already setup [here](./docker-compose.yaml). The only +field which should be modified is the `ports`, if need be. + +```shell +docker-compose up -d +``` + +### Docker + +```shell +docker run fuwn/maple:latest +``` + +### Executable + +1. Build: `ninja` (requires [Ninja](https://ninja-build.org/)) +2. Run: `out/maple`, or + `TITAN=1 TITAN_TOKEN=secret TITAN_MAX_SIZE=2048 out/maple` + ### Certificates Before any possible method of usage; you must generate or use a preexisting @@ -62,20 +83,6 @@ Takes an integer. Default to `1024`. -### Docker Compose - -A Docker Compose file is already setup [here](./docker-compose.yaml). The only -field which should be modified is the `ports`, if you have to. - -`$ docker-compose up -d` (requires [Docker](https://www.docker.com/) and/ or -[Docker Compose](https://docs.docker.com/compose/)) - -### Executable - -1. Build: `ninja` (requires [Ninja](https://ninja-build.org/)) -2. Run: `out/maple`, or - `TITAN=1 TITAN_TOKEN=secret TITAN_MAX_SIZE=2048 out/maple` - ### Hacking If you decide to tamper with Maple, you should give your commits a test. As -- cgit v1.2.3