Add How to install this library.

iwasakishuto · Apr 25, 2020 · 23d7c0c · 23d7c0c
1 parent f82bf4b
commit 23d7c0c
Showing 1 changed file with 30 additions and 74 deletions.
diff --git a/README.rst b/README.rst
@@ -20,96 +20,52 @@ Kerasy
 
 I want to **deepen my understanding of deep learning** by imitating the sophisticated neural networks API, **Keras**.
 
-Keras
-^^^^^
-
-..
-
-   .. image:: https://s3.amazonaws.com/keras.io/img/keras-logo-2018-large-1200.png
-      :target: https://s3.amazonaws.com/keras.io/img/keras-logo-2018-large-1200.png
-      :alt: Keras logo
-
-
-   .. image:: https://travis-ci.org/keras-team/keras.svg?branch=master
-      :target: https://travis-ci.org/keras-team/keras
-      :alt: Build Status
+Installation
+^^^^^^^^^^^^
 
+There are two ways to install Keras:
 
-   .. image:: https://img.shields.io/github/license/mashape/apistatus.svg?maxAge=2592000
-      :target: https://github.com/keras-team/keras/blob/master/LICENSE
-      :alt: license
 
-   Keras is a high-level neural networks API, written in Python and capable of running on top of `TensorFlow <https://github.com/tensorflow/tensorflow>`_\ , `CNTK <https://github.com/Microsoft/cntk>`_\ , or `Theano <https://github.com/Theano/Theano>`_. It was developed with a focus on enabling fast experimentation. *Being able to go from idea to result with the least possible delay is key to doing good research.*
+* **Install Kerasy from PyPI (recommended):**
+  .. code-block::
 
+       $ sudo pip install kerasy
 
-How to generate the articles.
------------------------------
+* **Alternatively: install Kerasy from the GitHub source:**
+  .. code-block::
 
-.. code-block:: sh
+       $ git clone https://github.com/keras-team/keras.git
+       $ cd keras
+       $ sudo python setup.py install
 
-   .Kerasy
-   ├── MkDocs
-   │   ├── MkDocs-important
-   |   |   |   ├── img
-   |   |   |   ├── theme
-   │   │   │   └── index.md
-   │   │   └── yml-templates.yml
-   │   ├── site
-   │   ├── MkDocs-src
-   │   └── mkdocs.yml
-   ├── README.md
-   ├── doc
-   ├── kerasy
-   ├── pelican
-   │   ├── Makefile
-   │   ├── backdrop
-   │   ├── pelican-src
-   │   ├── pelican-works
-   │   ├── pelicanconf.py
-   │   └── publishconf.py
-   └── pelican2mkdocs.py
+Why this name Kerasy
+^^^^^^^^^^^^^^^^^^^^
 
+Kerasy means "Keras" + "-y".
 
-#. Prepare articles (\ ``.md`` or ``.ipynb``.) NOTE: article name (\ ``XXX.md``\ ) and Slug(\ ``YYY``\ ) must be the same.(XXX=YYY)
-#. Generate the html article by `\ ``pelican`` <https://docs.getpelican.com/en/stable/>`_.
-   .. code-block:: sh
 
-       # @Kerasy/pelican
-       $ make html # pelican-src(.md, .ipynb) → pelican-works (.html)
+* `Keras <#Keras>`_ is a high-level neural networks API, written in Python.
+* "-y" is a native English suffix of adjectives meaning **"characterized by or inclined to"** the substance or action of the word or stem to which the suffix is attached. It often plays a role like **"ish"**\ , **"esque"**\ , or **"like"**.
 
-#. Move html files (made by pelican) to ``MkDocs-src`` as a ``.md`` style.
-#. Make a ``mkdocs.yml`` file
+Keras is my favorite library, so I wanted to imitate it and add more algorithms for in particular bioinformatics (which is my major.)
 
-   * Paset from ``yml-templates.yml``
-   * Get information from the Hierarchical structure of ``pelican-src``.
-     .. code-block::
-
-          # @Kerasy
-          $ python pelican2mkdocs
-
-#. Generate the articles by ``mkdocs build``.
-   .. code-block::
-
-       # @Kerasy/MkDocs
-       $ mkdocs build # MkDocs-src(.md) → site (.html)
+Keras
+~~~~~
 
-#. Copy some important static files (at ``MkDocs-important``\ ) to site dir
-#. Move ``MkDocs/site`` to ``doc``.
+..
 
-**※ A program that performs these operations collectively is `\ ``GithubKerasy.sh`` <https://github.com/iwasakishuto/iwasakishuto.github.io/blob/master/ShellScripts/GithubKerasy.sh>`_.**
+   .. image:: https://s3.amazonaws.com/keras.io/img/keras-logo-2018-large-1200.png
+      :target: https://s3.amazonaws.com/keras.io/img/keras-logo-2018-large-1200.png
+      :alt: Keras logo
 
-Upload to PyPI
---------------
 
-Create your account : `https://pypi.org/ <https://pypi.org/>`_
+   .. image:: https://travis-ci.org/keras-team/keras.svg?branch=master
+      :target: https://travis-ci.org/keras-team/keras
+      :alt: Build Status
 
-.. code-block::
 
-   # [Library packaging]
-   # Normal. (source distribution.)
-   # $ python setup.py sdist
-   # wheel version. (Recommended.)
-   $ python setup.py bdist_wheel
+   .. image:: https://img.shields.io/github/license/mashape/apistatus.svg?maxAge=2592000
+      :target: https://github.com/keras-team/keras/blob/master/LICENSE
+      :alt: license
 
-   # [Upload to PyPI]
-   $ twine upload dist/*
+   Keras is a high-level neural networks API, written in Python and capable of running on top of `TensorFlow <https://github.com/tensorflow/tensorflow>`_\ , `CNTK <https://github.com/Microsoft/cntk>`_\ , or `Theano <https://github.com/Theano/Theano>`_. It was developed with a focus on enabling fast experimentation. *Being able to go from idea to result with the least possible delay is key to doing good research.*