fix README

This commit is contained in:
Filip Gralinski 2015-12-20 19:52:02 +01:00
parent f95f99d364
commit b30532ee9c

View File

@ -1,43 +1,41 @@
Gonito platform Gonito platform
=============== ===============
Gonito (pronounced _ɡɔ̃ˈɲitɔ_) is a Kaggle-like platform for machine [Gonito](http://gonito.net) (pronounced _ɡɔ̃ˈɲitɔ_) is a Kaggle-like
learning competitions. platform for machine learning competitions (disclaimer: Gonito is
neither affiliated with nor endorsed by [Kaggle](https://www.kaggle.com)).
What's so special about Gonito: What's so special about Gonito:
* free & open-source (AGPL), you can use it your own, in your * free & open-source (AGPL), you can use it your own, in your
company, at your university, etc. company, at your university, etc.
* git-based (challenges and solutions are submitted only with git) * git-based (challenges and solutions are submitted only with git).
* not just competition, but also cooperation (solutions can be shared
and it's possible to follow their re-use)
See the home page (and an instance of Gonito) at http://gonito.net . See the home page (and an instance of Gonito) at http://gonito.net .
Installation Installation
------------ ------------
Gonito is written in Haskell and uses [Gonito](http://gonito.net) is written in [Haskell](https://www.haskell.org) and uses
[Yesod Web Framework](http://www.yesodweb.com/), but all you need is [Yesod Web Framework](http://www.yesodweb.com/), but all you need is
just [the Stack tool](https://github.com/commercialhaskell/stack). See https://github.com/commercialhaskell/stack just [the Stack tool](https://github.com/commercialhaskell/stack). See https://github.com/commercialhaskell/stack
for instruction how to install Stack on your computer. for instruction how to install Stack on your computer.
By default, Gonito uses Postgresql, so it needs to be installed and running at your computer. By default, Gonito uses [Postgresql](http://www.postgresql.org/), so it needs to be installed and running at your computer.
After installing Stack: After installing Stack:
~~~ {.bash} createdb -E utf8 gonito
createdb -E utf8 gonito git clone git://gonito.net/geval
git clone git://gonito.net/geval git clone git://gonito.net/gonito
git clone git://gonito.net/gonito cd gonito
cd gonito stack setup
stack setup stack build
stack build stack exec yesod devel
stack exec yesod devel
~~~
The last command will start the Web server with Gonito (go to The last command will start the Web server with Gonito (go to
http//127.0.0.1:3000 in your browser). http://127.0.0.1:3000 in your browser).
Authors Authors
------- -------