Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

README for newbies #64

Closed
wants to merge 2 commits into from
Closed

README for newbies #64

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d4cb488
- Added a prerequistes section to the README
tjkierzkowski Aug 19, 2014
c8363ef
- Added a useless build section
tjkierzkowski Aug 19, 2014
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 20 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,21 @@
hematite
========
# Hematite

A simple Minecraft written in Rust with the Piston game engine
A simple Minecraft written in Rust with the Piston game engine.

## Prerequistes
- [Rust](http://www.rust-lang.org/install.html)
- [Cargo](http://crates.io/)
- if you don't already have it, its available from the nightly build script below:
~~~
$ curl -s https://static.rust-lang.org/rustup.sh | sudo sh
~~~
- [GLFW 3.x](http://www.glfw.org/download.html) for your respective OS
- details on [how to compile](http://www.glfw.org/docs/latest/compile.html)
- if you have OSX and [Homebrew](http://brew.sh/) installed, try the following
~~~
$ brew install glfw3
~~~

## Build

TODO