aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorWilliam Hergès <william@herges.fr>2025-09-07 14:24:30 +0200
committerWilliam Hergès <william@herges.fr>2025-09-07 14:24:30 +0200
commite8da79df02b9045146e2a0cb9e035f14a68537c6 (patch)
treed8b188d846a948334c553687bba37b3e5bb49280
parent0439f4219e5f2e6a7ebbe8324fe8a5dbd456822a (diff)
docs(info): installation instruction in readme
-rw-r--r--README.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/README.md b/README.md
index ff6a759..a5d168f 100644
--- a/README.md
+++ b/README.md
@@ -7,6 +7,29 @@ Lightweight and heavily customizable Go application.
![Screenshot of a custom page](music.jpg)
+## Installation
+
+Dependencies:
+- Go 1.24+
+- Bun
+- just
+
+Clone the repository:
+```bash
+git clone https://git.anhgelus.world/anhgelus/now.git
+cd now
+```
+
+Build the project with just:
+```bash
+just build
+```
+
+You can also manually build it by reading the content of `justfile` and executing the command.
+
+The `now` binary produced contains everything needed and can be executed on the same OS with the same arch.
+Execute it with the flag `-help` to get the list of available options.
+
## Config
You must have a `public` directory.
Everything located inside will be available at the path `/static/PATH` where `PATH` is the relative path inside the