Update README to prepare for public release!
This commit is contained in:
parent
03d2946ab5
commit
577e0ab89f
1 changed files with 29 additions and 1 deletions
30
README.md
30
README.md
|
@ -1,3 +1,31 @@
|
|||
# MarkovGrams
|
||||
|
||||
Experiments into markov chains, n-grams, and text generation.
|
||||
Experiments into markov chains, n-grams, and text generation.
|
||||
|
||||
## Building
|
||||
|
||||
### Windows
|
||||
Open the solution in Visual Studio / MonoDevelop and hit build.
|
||||
|
||||
### Linux and everyone else
|
||||
As above with MonoDevelop, or simply use the command `xbuild` whilst inside the root of the repository.
|
||||
|
||||
## Using
|
||||
Detailed usage help can be seen by simply running the tool without any arguments:
|
||||
|
||||
```bash
|
||||
./MarkovGrams.exe
|
||||
```
|
||||
|
||||
Linux users might need to explicitly run it with `mono`:
|
||||
|
||||
```bash
|
||||
mono ./MarkovGrams.exe
|
||||
```
|
||||
|
||||
## Credits
|
||||
- The code was written by [Starbeamrainbowlabs](https://starbeamrainbowlabs.com/) - that's me!
|
||||
- I found the [Markov Chain Text Generation](http://nullprogram.com/blog/2012/09/05/) post by [Chris Wellons](http://nullprogram.com/) rather useful when writing this.
|
||||
- Wordlists
|
||||
- The list of colours was built with a sneaky bit of Javascript in the developer tools of [this webpage](http://www.colorhexa.com/color-names) from [colorhexa](http://www.colorhexa.com/), which turns out to be a really useful website about colours.
|
||||
- The list of sciencey words was built from scratch by [Starbeamrainbowlabs](https://starbeamrainbowlabs.com/) - that's me too!
|
||||
|
|
Loading…
Reference in a new issue