diff --git a/README.md b/README.md index 076b7fded72d798c678e348b6a361fc7943f9bb0..7ce616b96a9d00a466dbd14668def4a667d13309 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,49 @@ -# autokara +# AutoKara -AI that can time automatically karas. \ No newline at end of file +AI that can time automatically karas. + +# Some documentation first + +- https://realpython.com/python-virtual-environments-a-primer/ +- https://www.pyimagesearch.com/2016/11/14/installing-keras-with-tensorflow-backend/ + +# Installation + +## Python + +You need python 3 with the tensorflow library. We will set up a virtual envireonment to not mess up with the system. +To do that you will need [virtualenv](https://virtualenv.pypa.io/en/stable/) and +[virtualenvwrapper](https://virtualenvwrapper.readthedocs.io/en/latest/). + +One way to do it, in the correct directory (the project's one), enter the commands: +```bash +$ python3 -m venv env # create the virtual envireonment, do it once +$ source env/bin/activate # use the virtual envireonement + +# Here goes the install commands +$ pip install --upgrade tensorflow +$ pip install numpy scipy +$ pip install scikit-learn +$ pip install pillow +$ pip install h5py +$ pip install keras + +$ deactivate # quit the virtual envireonment +``` + +Or, an other way to do it: + +```bash +$ mkvirtualenv keras_tf -p python3 # create the virtual envireonment, do it once +$ workon keras_tf # use the virtual envireonement + +# Here goes the install commands +$ pip install --upgrade tensorflow +$ pip install numpy scipy +$ pip install scikit-learn +$ pip install pillow +$ pip install h5py +$ pip install keras + +# don't know how to quit, find it yourself +``` \ No newline at end of file