From 788c7ad6c0c394a47628e61187c8af1f037eb02a Mon Sep 17 00:00:00 2001 From: sessionm21 Date: Sat, 2 Jun 2018 21:28:07 -0700 Subject: [PATCH] update README --- README.md | 19 ++++++++++++++++--- 1 file changed, 16 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 32e06fd..d1d9d47 100644 --- a/README.md +++ b/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 \ No newline at end of file