Attempt at a README.md

This commit is contained in:
Thinkofname 2016-03-31 22:20:10 +01:00
parent b161e3004c
commit e6ec9b3200
1 changed files with 33 additions and 0 deletions

33
README.md Normal file
View File

@ -0,0 +1,33 @@
# Steven (Rust)
A Minecraft client coded in Rust. Ported from [steven-go](https://github.com/Thinkofname/steven).
Don't expect it to go anywhere, just doing this for fun.
## Images
![Steven blocks demo](https://i.imgur.com/U46LTZN.png)
In action: http://gfycat.com/NeedyElaborateGypsymoth
## Chat
I generally am on the `irc.spi.gt` irc network in the `#think` channel.
Feel free to pop in to say hi, [Webchat can be found here](https://irc.spi.gt/iris/?channels=think)
## Building
Currently requires SDL2 and OpenSSL to build.
`cargo build --release`
## Running
### Standalone
Just running steven via a double click (Windows) or `./steven` (everything else)
will bring up a login screen followed by a server list which you can select a server
from.
### Via the Offical Minecraft launcher
Currently not supported (yet)