diff options
| author | Aaron LI <aly@aaronly.me> | 2018-11-08 17:04:42 +0800 |
|---|---|---|
| committer | Aaron LI <aly@aaronly.me> | 2018-11-08 17:04:42 +0800 |
| commit | a855ea02d9563b5ea1b701dea7c15806ad955ce3 (patch) | |
| tree | ef89320c7f5b674f02942eafe323d11acd496f32 /README.rst | |
| parent | 871d745c1832f8c919c5c6df6d044a68bd861246 (diff) | |
| download | fg21sim-a855ea02d9563b5ea1b701dea7c15806ad955ce3.tar.bz2 | |
README: Fix style and clean up a bit
Diffstat (limited to 'README.rst')
| -rw-r--r-- | README.rst | 22 |
1 files changed, 7 insertions, 15 deletions
@@ -48,28 +48,28 @@ Installation ------------ 1. Clone this repository:: - $ git clone https://github.com/liweitianux/fg21sim + $ git clone https://github.com/liweitianux/fg21sim 2. Install the above required software and libraries. 3. Install the required third-party Python packages. And it is recommended to use the `virtual environment`_:: - $ cd fg21sim/ - $ make venv - $ . venv/bin/activate - (venv) $ + $ cd fg21sim/ + $ make venv + $ . venv/bin/activate + (venv) $ Check to make sure that this virtual environment is activated so that the ``python3`` and ``pip3`` are pointed to the virtual environment. 4. Install this software into the virtual environment:: - (venv) $ python3 setup.py install + (venv) $ python3 setup.py install 5. You are ready to use this software. Just have a look, e.g.:: - (venv) $ fg21sim --help + (venv) $ fg21sim --help Development @@ -90,11 +90,6 @@ Documentations To get started, read the `User Guide`_. -Contributions -------------- -Great! Be sure to consult the guidelines in |CONTRIBUTING.md|_. - - Authors ------- * Weitian LI <``wt@liwt.net``> @@ -121,9 +116,6 @@ Unless otherwise declared: .. _FG21sim: https://github.com/liweitianux/fg21sim .. _`User Guide`: https://github.com/liweitianux/fg21sim/blob/master/docs/guide.rst -.. |CONTRIBUTING.md| replace:: ``CONTRIBUTING.md`` -.. _CONTRIBUTING.md: - https://github.com/liweitianux/fg21sim/blob/master/CONTRIBUTING.md .. |LICENSE-3RDPARTY| replace:: ``LICENSE-3RDPARTY`` .. _LICENSE-3RDPARTY: https://github.com/liweitianux/fg21sim/blob/master/LICENSE-3RDPARTY |