TinyCsvParser is an open source project and there are many ways to contribute to it.
Some things you could help out with are:
- Documentation (both code and features)
- Bug reports
- Bug fixes
- Feature requests
- Feature implementations
- Test coverage
- Code quality
- Sample applications
The TinyCsvParser project is hosted on GitHub at:
Want to get your hands on the sources? Then clone the repository using the following git command:
git clone https://github.com/bytefish/TinyCsvParser
Building the Documentation¶
Once you have cloned the repository to your local machine, the following instructions will walk you through installing the tools necessary to build the documentation.
Download python version 2.7.10 or higher.
If you are installing on Windows, ensure both the Python install directory and the Python scripts directory have been added to your
PATHenvironment variable. For example, if you install Python into the
c:\python34 directory, you would add
Install Sphinx by opening a command prompt and running the following Python command. (Note that this operation might take a few minutes to complete.)
pip install sphinx
By default, when you install Sphinx, it will install the ReadTheDocs custom theme automatically. If you need to update the installed version of this theme, you should run:
pip install -U sphinx_rtd_theme
Navigate to one of the projects Documentation located at
make.baton Windows, Makefile on Mac/Linux) from command line:
Once make completes, the generated docs will be in the
.../Documentation/build/htmldirectory. Simply open the
index.htmlfile in your browser to see the built documentation.