update README
This commit is contained in:
parent
8081f3a483
commit
788c7ad6c0
19
README.md
19
README.md
|
@ -1,14 +1,25 @@
|
|||
# Go
|
||||
|
||||
TODO: Write a description here
|
||||
This is an implementation of a game of GO in web application form.
|
||||
|
||||
## Installation
|
||||
|
||||
TODO: Write installation instructions here
|
||||
TODO: Write installation instructions for Windows
|
||||
___
|
||||
TODO: Write installation instructions for Mac
|
||||
___
|
||||
Arch Linux:
|
||||
1. Install dependencies: `pacman -S crystal, shards, ruby-sass`
|
||||
2. Install Shards: `shards install`
|
||||
3. TODO: Add elm compilation
|
||||
4. Compile SASS Style: `make generate-css`
|
||||
5. Compile Crystal app: `crystal build --release src/Go.cr`
|
||||
6. Run with `./Go`
|
||||
___
|
||||
|
||||
## Usage
|
||||
|
||||
TODO: Write usage instructions here
|
||||
While crystal app is running, go to localhost with port of 3000 in the browser.
|
||||
|
||||
## Development
|
||||
|
||||
|
@ -25,3 +36,5 @@ TODO: Write development instructions here
|
|||
## Contributors
|
||||
|
||||
- [[your-github-name]](https://github.com/[your-github-name]) Danila Fedorin - creator, maintainer
|
||||
|
||||
- [sessionm21](https://github.com/sessionm) Matthew Sessions - hax0r, maintainer
|
Loading…
Reference in New Issue
Block a user