MOD: change README.md into README.rst

Moguf · Aug 24, 2016 · 5536d6e · 5536d6e
1 parent 552aae5
commit 5536d6e
Show file tree

Hide file tree

Showing 4 changed files with 65 additions and 44 deletions.
diff --git a/README.md b/README.md
diff --git a/README.rst b/README.rst
@@ -0,0 +1,63 @@
+.. -*- mode: rst -*-
+   
+|Travis|_ |Coveralls|_ |Python35|_
+
+.. |Travis| image:: https://travis-ci.org/Moguf/cafepy.svg?branch=master
+.. _Travis: https://travis-ci.org/Moguf/cafepy
+
+.. |Coveralls| image:: https://coveralls.io/repos/github/Moguf/cafepy/badge.svg?branch=master
+.. _Coveralls: https://coveralls.io/github/Moguf/cafepy?branch=master
+
+.. |Python35| image:: image:: https://img.shields.io/badge/python-3.5-blue.svg
+
+cafepy(Python3 scripts)
+=======================
+
+These scripts are for analyzing CafeMol outputs.
+
+Requirements
+------------
+
+- python3 >= 3.5.1
+
+* Install virtualenv. (RECOMMEND:for protecting your Home environment.)
+
+  python3 -m pip install -U pip setuptools
+  python3 -m pip install virtualenv
+
+# or
+pip3 install virtualenv
+```
+* activate virtualenv
+```bash
+virtualenv -p python3 venv
+source venv/bin/activate
+# Removing virtual environment
+# (venv) deactivate 
+```
+
+Set Up
+------
+
+```bash
+python3 -m pip install -r requirements.txt
+# or
+pip3 install -r requirements.txt
+```
+
+build & install
+---------------
+
+```
+cd cafepy
+python3 setup.py build
+python3 setup.py install
+```
+
+Example
+-------
+
+```bash
+python3 -m cafepy com -f filename.dcd -o output.file
+
+```
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -13,11 +13,9 @@ Contents:
 
    cafepy
 
-
-
-
+   ../../README.md
 
-              
+
 Indices and tables
 ==================
 

diff --git a/test/test_write_cafeinp.py → test/test_cafeinpfile.py b/test/test_write_cafeinp.py → test/test_cafeinpfile.py