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