Documentation introduction and setup.py modified

MANIFEST.in

@@ -1,2 +1,2 @@
-include *.txt *.ini *.cfg *.rst
+include *.txt *.md *.ini *.cfg *.rst
 recursive-include lingvodoc *.ico *.png *.css *.gif *.jpg *.pt *.txt *.mak *.mako *.js *.html *.xml

README.md

@@ -0,0 +1,34 @@
+LingvoDoc project
+==================
+
+This project is dedicated to natural languages and dialects documentation. It's the continuation of Dialeqt project
+(which was written in C++/QT5/Pure SQL).
+LingvoDoc is intended to provide natural language documentation service as Web-service and provides REST API and
+ajax-based client application.
+
+
+Dependancies
+---------------
+
+- pyramid (framework)
+
+- sqlalchemy (ORM)
+
+
+Running the project for development
+---------------
+
+- Create virtual python environment for Python (3.3+ recommended; 2.7+ should work too but is not tested)
+
+- Declare env variable for your virtual environment: export VENV=<path to your virtual environment>
+
+- cd <directory containing this file>
+
+- $VENV/bin/python setup.py develop
+
+- $VENV/bin/initialize_lingvodoc_db development.ini
+
+- $VENV/bin/pserve development.ini
+
+API documentation
+---------------

setup.py

@@ -3,9 +3,9 @@
 from setuptools import setup, find_packages
 
 here = os.path.abspath(os.path.dirname(__file__))
-with open(os.path.join(here, 'README.txt')) as f:
+with open(os.path.join(here, 'README.md')) as f:
     README = f.read()
-with open(os.path.join(here, 'CHANGES.txt')) as f:
+with open(os.path.join(here, 'CHANGES.md')) as f:
     CHANGES = f.read()
 
 requires = [
@@ -29,10 +29,10 @@
         "Topic :: Internet :: WWW/HTTP",
         "Topic :: Internet :: WWW/HTTP :: WSGI :: Application",
         ],
-      author='',
-      author_email='',
-      url='',
-      keywords='web wsgi bfg pylons pyramid',
+      author='Oleg Borisenko',
+      author_email='[email protected]',
+      url='https://lingvodoc.ispras.ru/',
+      keywords='web wsgi bfg pylons pyramid sqlalchemy',
       packages=find_packages(),
       include_package_data=True,
       zip_safe=False,