update readme
This commit is contained in:
parent
743da6a893
commit
7eb1301599
|
@ -18,8 +18,3 @@ Known Issues
|
|||
* If a zero was typed in a DATE formatted field in xls, you will get "01/01/1900".
|
||||
* If a zero was typed in a TIME formatted field in xls, you will get "00:00:00".
|
||||
{%endblock%}
|
||||
|
||||
Developer guide
|
||||
==================
|
||||
|
||||
{%include 'developer_guide.rst.jj2' %}
|
||||
|
|
61
README.rst
61
README.rst
|
@ -1,31 +1,3 @@
|
|||
Development steps for code changes
|
||||
|
||||
#. git clone https://github.com/pyexcel/pyexcel-xls.git
|
||||
#. cd pyexcel-xls
|
||||
#. pip install -r requirements.txt
|
||||
#. pip install -r tests/requirements.txt
|
||||
|
||||
|
||||
In order to update test envrionment, and documentation, additional setps are
|
||||
required:
|
||||
|
||||
#. pip install moban
|
||||
#. git clone https://github.com/pyexcel/pyexel-commons.git
|
||||
#. make your changes in `.moban.d` directory, then issue command `moban`
|
||||
|
||||
|
||||
How to test your contribution
|
||||
------------------------------
|
||||
|
||||
Although `nose` and `doctest` are both used in code testing, it is adviable that unit tests are put in tests. `doctest` is incorporated only to make sure the code examples in documentation remain valid across different development releases.
|
||||
|
||||
On Linux/Unix systems, please launch your tests like this::
|
||||
|
||||
$ make test
|
||||
|
||||
On Windows systems, please issue this command::
|
||||
|
||||
> test.bat
|
||||
================================================================================
|
||||
pyexcel-xls - Let you focus on data, instead of xls format
|
||||
================================================================================
|
||||
|
@ -249,6 +221,39 @@ License
|
|||
|
||||
New BSD License
|
||||
|
||||
Developer guide
|
||||
==================
|
||||
|
||||
Development steps for code changes
|
||||
|
||||
#. git clone https://github.com/pyexcel/pyexcel-xls.git
|
||||
#. cd pyexcel-xls
|
||||
#. pip install -r requirements.txt
|
||||
#. pip install -r tests/requirements.txt
|
||||
|
||||
|
||||
In order to update test envrionment, and documentation, additional setps are
|
||||
required:
|
||||
|
||||
#. pip install moban
|
||||
#. git clone https://github.com/pyexcel/pyexel-commons.git
|
||||
#. make your changes in `.moban.d` directory, then issue command `moban`
|
||||
|
||||
|
||||
How to test your contribution
|
||||
------------------------------
|
||||
|
||||
Although `nose` and `doctest` are both used in code testing, it is adviable that unit tests are put in tests. `doctest` is incorporated only to make sure the code examples in documentation remain valid across different development releases.
|
||||
|
||||
On Linux/Unix systems, please launch your tests like this::
|
||||
|
||||
$ make test
|
||||
|
||||
On Windows systems, please issue this command::
|
||||
|
||||
> test.bat
|
||||
|
||||
|
||||
Known Issues
|
||||
=============
|
||||
|
||||
|
|
Loading…
Reference in New Issue