diff --git a/README.md b/README.md index eebf224..7d75080 100644 --- a/README.md +++ b/README.md @@ -14,14 +14,26 @@ pyrenn is a [recurrent neural network](https://en.wikipedia.org/wiki/Recurrent_n * It comes with various examples which show how to create, train and use the neural network -## Get Started +## Installation + +### Install with pip (python only) + +From your command line, run: + +```bash +pip install pyrenn +``` + +### Install manually 1. [download](https://github.com/yabata/pyrenn/archive/master.zip) or clone (with [git](http://git-scm.com/)) this repository to a directory of your choice. 2. * Python: Copy the `pyrenn.py` file in the `python` folder to a directory which is already in python's search path or add the `python` folder to python's search path (sys.path) ([how to](http://stackoverflow.com/questions/17806673/where-shall-i-put-my-self-written-python-packages/17811151#17811151)) * Matlab: Add the `matlab` folder to Matlab's search path ([how to](http://www.mathworks.com/help/matlab/matlab_env/add-remove-or-reorder-folders-on-the-search-path.html)) -3. Run the given examples in the `examples` folder. -4. Read the [documenation](http://pyrenn.readthedocs.org) and create your own neural network + +## Get Started +1. Run the given examples in the `examples` folder. +2. Read the [documenation](http://pyrenn.readthedocs.org) and create your own neural network ## Copyright diff --git a/setup.cfg b/setup.cfg new file mode 100644 index 0000000..224a779 --- /dev/null +++ b/setup.cfg @@ -0,0 +1,2 @@ +[metadata] +description-file = README.md \ No newline at end of file diff --git a/setup.py b/setup.py index 9002f61..f8e8ccb 100644 --- a/setup.py +++ b/setup.py @@ -16,7 +16,9 @@ py_modules=['pyrenn'], license='GPL', author='Dennis Atabay', + author_email = 'dennis.atabay@gmail.com', url='http://github.com/yabata/pyrenn', + download_url = 'https://github.com/yabata/pyrenn/archive/v0.1.tar.gz', description='A recurrent neural network toolbox for Python and Matlab.', install_requires=[ 'numpy'