Skip to content

Commit 62dc45d

Browse files
committed
📚 re-arrange content in readme
1 parent b71e34f commit 62dc45d

File tree

1 file changed

+26
-25
lines changed

1 file changed

+26
-25
lines changed

README.rst

Lines changed: 26 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -30,15 +30,17 @@ mó bǎn - 模板 General purpose static text generator
3030
:Issues: http://github.com/moremoban/moban/issues
3131
:License: MIT
3232

33-
.. image:: https://github.com/moremoban/moban/raw/dev/docs/images/moban-in-intro.gif
33+
.. image:: https://github.com/moremoban/moban/raw/dev/docs/images/moban-in-pyexcel-demo.gif
3434

3535
Announcement
3636
================================================================================
3737

38+
From 2020 onwards, minimum requirement is Python 3.6
39+
40+
3841
For existing moban users, python 2 support has been dropped. Please stay with
3942
versions lower than 0.7.0 if you are still using python 2.
4043

41-
From 2020 onwards, minimum requirement is Python 3.6
4244

4345
Introduction
4446
================================================================================
@@ -67,6 +69,8 @@ And here is a list of other usages:
6769
#. `Math Sheets <https://github.com/chfw/math-sheets>`_, generate custom math sheets in pdf
6870

6971

72+
All use cases are documented `here <http://moban.readthedocs.org/en/latest/#tutorial>`_
73+
7074
Vision
7175
================================================================================
7276

@@ -89,27 +93,13 @@ Credit
8993
`jinja2-fsloader <https://github.com/althonos/jinja2-fsloader>`_ is the key component to enable PyFilesystem2 support in moban
9094
v0.6x. Please show your stars there too!
9195

92-
Installation
93-
================================================================================
94-
You can install it via pip:
95-
96-
.. code-block:: bash
97-
98-
$ pip install moban
99-
100-
101-
or clone it and install it:
102-
103-
.. code-block:: bash
104-
105-
$ git clone http://github.com/moremoban/moban.git
106-
$ cd moban
107-
$ python setup.py install
108-
10996

11097
Quick start
11198
================================================================================
11299

100+
.. image:: https://github.com/moremoban/moban/raw/dev/docs/images/moban-in-intro.gif
101+
102+
113103
.. code-block:: bash
114104
115105
$ export HELLO="world"
@@ -160,12 +150,6 @@ moban.output will contain:
160150
161151
Please note that data.yml will take precedence over environment variables.
162152

163-
Moban in live action:
164-
165-
.. image:: https://github.com/moremoban/moban/raw/dev/docs/images/moban-in-pyexcel-demo.gif
166-
167-
All use cases are documented `here <http://moban.readthedocs.org/en/latest/#tutorial>`_
168-
169153

170154
Templates and configuration files over HTTP(S)
171155
================================================================================
@@ -251,6 +235,23 @@ Where the configuration sits in a s3 bucket, the output is a file in a zip. The
251235
hello: world
252236
253237

238+
Installation
239+
================================================================================
240+
You can install it via pip:
241+
242+
.. code-block:: bash
243+
244+
$ pip install moban
245+
246+
247+
or clone it and install it:
248+
249+
.. code-block:: bash
250+
251+
$ git clone http://github.com/moremoban/moban.git
252+
$ cd moban
253+
$ python setup.py install
254+
254255
255256
CLI documentation
256257
================================================================================

0 commit comments

Comments
 (0)