From a68afb81885ffdf0d6fe58df5aee57d7e7653ee9 Mon Sep 17 00:00:00 2001 From: Lia Lenckowski Date: Fri, 25 Aug 2023 16:57:08 +0200 Subject: document build process --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 9e98f7a..7dd2aa4 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,14 @@ The server keeps its own list of bangs, initialized with those from duckduckgo. There is a public instance running at [search.metamuffin.org](https://search.metamuffin.org), running on a server in germany. +## Building +The build-time dependencies are curl, make, esbuild, sassc, and stack. Under arch linux, you may install these with `paru -Syu make esbuild sassc stack-static`, replacing `paru` with your AUR-helper of choice. + +With these installed, run `make`. This will take a few minutes, but recompiling after an update should be quick. + +## Running +Building leaves you with a directory named `deploy`. Copy this onto the machine you want to run the server on and run the `fastbangs` executable found inside, using the `deploy` directory as your working directory. + ## Configuration Configuration is done through environment variables, or a file named "fastbangs.yaml" sitting in the working directory of the server. Running `make` will include a default config. -- cgit v1.2.3-70-g09d2