chore: update README
This commit is contained in:
parent
511a1b021c
commit
aec3ebba9a
1 changed files with 33 additions and 0 deletions
33
README.md
33
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
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue