summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorClaudius Holeksa <mail@keldu.de>2023-05-10 09:48:42 +0200
committerClaudius Holeksa <mail@keldu.de>2023-05-10 09:48:42 +0200
commita5bb64f9cc957348df68b49976908d0c08d05fbd (patch)
tree6fdc120dfed26ec79bd892b38b6051c9b71baf83
parentab54cfdc75005fab5dcad3d5b105d38f6c8ae432 (diff)
downloadmini-test-a5bb64f9cc957348df68b49976908d0c08d05fbd.tar.gz
Clarified the install process (slightly)
-rw-r--r--README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/README.md b/README.md
index 6695df3..3a62c2b 100644
--- a/README.md
+++ b/README.md
@@ -8,6 +8,22 @@ So here we are.
This works similarly to other test frameworks.
# Building
+## The project itself
+
+### Dependencies
+
+* c++ compiler (c++17) (Usually clang)
+* gnumake (or any other flavor)
+
+Also at `.nix/derivation.nix` the nix build env is specified.
+If any other questions arise you can check the supplied dependencies and install process there.
+
+### Install into your env
+
+`PREFIX` env variable decides where the install directory lives. Default is `/usr/local`
+
+* `make install`
+
## If keltest is available in env
This really is the recommended case. Put things in your env. That's why it exists. Drop in your build container if you must, but just put it in your env.