aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorZhongheng Liu <z.liu@outlook.com.gr>2024-10-22 21:44:23 +0300
committerZhongheng Liu <z.liu@outlook.com.gr>2024-10-22 21:44:23 +0300
commitaec3ebba9a2c97e8368851e24147e93898ec1bfd (patch)
tree9616a6e0fe95e8ec78df836022b155ed698d67bb
parent511a1b021c022d38beda1df556b99fba0f06a9e6 (diff)
downloadrulmarc-aec3ebba9a2c97e8368851e24147e93898ec1bfd.tar.gz
rulmarc-aec3ebba9a2c97e8368851e24147e93898ec1bfd.tar.bz2
rulmarc-aec3ebba9a2c97e8368851e24147e93898ec1bfd.zip
chore: update README
-rw-r--r--README.md33
1 files changed, 33 insertions, 0 deletions
diff --git a/README.md b/README.md
index 06b1f2c..e4a92f9 100644
--- a/README.md
+++ b/README.md
@@ -2,3 +2,36 @@
RPG Using Language Models As Realistic Characters
An experiment to see how LLMs can be useful to make believable characters in role-playing games.
+
+## Build instructions
+
+### Nix machines with devenv
+
+1. Clone the project.
+2. Enter the project directory.
+3. Enter the following command:
+```
+$ devenv shell
+```
+4. In the shell, run:
+```
+$ build
+```
+5. You will find the build artifact in the ./bin/ directory.
+
+### Other machines
+
+1. Install Go.
+2. Clone the project.
+3. Run the following command:
+```
+$ go build -o ./bin/
+```
+4. You will find the build artifact in the ./bin/ directory.
+
+## Notes
+
+This project is in a pre-pre-pre-alpha state.
+It should not yet be considered usable.
+
+Currently in active development