Macchinetta Client (1.x) Development Guideline
NOTE: This repository is OBSOLETE. It has not been updated since March 2019.
This guideline helps to proceed with the software development (mainly coding) smoothly.
Source files
Source files of this guideline are stored into following directories.
- Japanese version :
{repository root}/source/
Source file format
This guideline is written by the reStructuredText format(.rst).
About the reStructuredText format, refer to the Sphinx documentation contents.
How to build
We build to HTML files using the Sphinx. About the Sphinx, refer to the Sphinx documentation contents.
Install the Sphinx
Please install the Python and Sphinx.
Clone a repository
Please clone a Macchinetta/client-guideline repository or forked your repository.
git clone https://github.com/Macchinetta/client-guideline.git
or
git clone https://github.com/{your account}/client-guideline.git
Build HTML files
Please execute the build-html.sh or build-html.bat.
If build is successful, HTML files generate to the {your repository}/build/html/ directory.
Linux or Mac:
$ cd {your repository directory}
$ ./build-html.sh
Windows:
> cd {your repository directory}
> build-html.bat
Terms of use
Terms of use refer to here.