GoServer/README.md
2018-06-02 21:50:23 -07:00

41 lines
1.1 KiB
Markdown

# Go
This is an implementation of a game of GO in web application form.
## Installation
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
While crystal app is running, go to localhost with port of 3000 in the browser.
## Development
TODO: Write development instructions here
## Contributing
1. Fork it ( https://github.com/[your-github-name]/Go/fork )
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request
## Contributors
- [[your-github-name]](https://github.com/[your-github-name]) Danila Fedorin - creator, maintainer
- [sessionm21](https://github.com/sessionm21) Matthew Sessions - hax0r, maintainer