change readme

yoshida-lab · Jan 29, 2018 · 34f191a · 34f191a
1 parent ef6e612
commit 34f191a
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 29 deletions.
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -1,4 +1,4 @@
-include *.rst LICENSE.rst CHANGES.rst requirements*.txt
+include *.rst LICENSE.rst docs/source/CHANGES.rst requirements*.txt
 recursive-include xenonpy *.py *.json *.yaml *.pkl.pd_ *.pkl.z
 recursive-exclude tests/*.*
 recursive-include licences *
diff --git a/README.rst b/README.rst
@@ -39,6 +39,12 @@ Contribution guidelines
 * Check codes with Pylint
 * Writing tests if possible
 
+
+Changes
+=======
+
+.. include: docs/source/CHANGES.rst
+
 Contract
 ========
 

diff --git a/CHANGES.rst → docs/source/CHANGES.rst b/CHANGES.rst → docs/source/CHANGES.rst
diff --git a/docs/source/installation.rst b/docs/source/installation.rst
@@ -9,52 +9,31 @@ XenonPy use PyTorch_ as the NN engine backend because of it's flexibility and hi
 Since PyTorch has no common installation recipe beacuse it dependent on what your OS is and either use `CUDA <https://developer.nvidia.com/cuda-toolkit>`_.
 So unfortunately, you have to install PyTorch manually after the installation of XenonPy.
 
+
 Let we say:
 
 * :ref:`install_xenonpy` 
 * :ref:`install_pytorch`
 
 .. note::
 
-    Installation on Unix-like system is actually quite simple. For windows the installation is relative triviality.
-    We highly recommend you to install `Visual C++ Build Tools <http://landinghub.visualstudio.com/visual-cpp-build-tools>`_ before you install other python packages.
-
-.. tip::
+    When installation, some dependence which have C/Cython files need to be compiled.
+    On Unix-like system is actually quite simple only need you to install compile toolchain. For windows the installation is relative triviality.
+    Before you install python packages. First install `Visual C++ Build Tools <http://landinghub.visualstudio.com/visual-cpp-build-tools>`_.
+    Also you have to checked on **windows 8.1 / 10 SDK options** when install Visual C++ Build Tools.
 
-    If you got ``fatal error C1083: Cannot open include file: 'basetsd.h': No such file or directory`` error when install via ``pip``.
-    Try checked windows 8.1 / 10 SDK options when install Visual C++ Build Tools.
 
 .. _install_xenonpy:
 
 Step1: Install XenonPy
 =======================
 
 
-via anaconda (recommended)
---------------------------
-The easiest way to install XenonPy is using conda_. If you don't have conda_ follow the `official installation documents <https://conda.io/docs/user-guide/install/index.html>`_.
-
-We created a channel to build a collection of our materials science software,
-If you already have conda installed, XenonPy can be installed from the `yoshida-lab channel`_ using the following one line command:
-
-.. code-block:: bash
-
-   $ conda install --channel yoshida-lab xenonpy
-
-
-XenonPy is under active development, many new features are added regularly. To
-upgrade pymatgen to the latest version, use the following command:
-
-.. code-block:: bash
-
-   $ conda upgrade xenonpy
-
-
-
 via pip
 --------------------------
 
-If you don't/can't install conda_. A common way is to use pip_.
+A common way to install python packages is pip_.
+
 Simply run the command in a bash terminal:
 
 .. code-block:: bash