Browse Source

Initial readme file

Alex Myasoedov 8 years ago
parent
commit
2b1515722a
1 changed files with 23 additions and 0 deletions
  1. 23 0
      Readme.md

+ 23 - 0
Readme.md

@@ -0,0 +1,23 @@
+## Hacker Slides
+
+This repo is a reworked version of [Sandstorm Hacker Slides](https://github.com/jacksingleton/hacker-slides) which features easy set up run outside of Sandstorm and without vagrant-spk. Likewise you can publish and edit your previous slides in markdown.  
+
+To build and run it locally
+```go
+go get
+go run main.go
+
+[GIN-debug] Listening and serving HTTP on :8080
+```
+
+And then you can just open [http://127.0.0.2:8080](http://127.0.0.2:8080) and it's ready to use.
+
+### Todos:
+- Docker image
+
+
+Getting Help
+------------
+
+For **feature requests** and **bug reports**  submit an issue
+to the GitHub issue tracker