Skip to content

Latest commit

 

History

History
68 lines (50 loc) · 3.17 KB

README.md

File metadata and controls

68 lines (50 loc) · 3.17 KB
Raw

GitHub Build GitHub license GitHub release (latest SemVer) GitHub forks GitHub stars GitHub issues

OpenMV Documentation

The OpenMV Cam documentation.

How to build

Install Sphinx, and optionally (for the RTD-styling), sphinx_rtd_theme, preferably in a virtualenv:

 pip install sphinx
 pip install sphinx_rtd_theme

In /, build the docs:

 make.py

You'll find the index page at micropython/docs/_build/html/index.html.

Contributing to the project

Contributions are most welcome. If you are interested in contributing to the project, start by creating a fork of each of the following repositories:

Clone the forked openmv-doc repository, and add a remote to the main openmv-doc repository:

git clone --recursive https://github.com/<username>/openmv-doc.git
git -C openmv-doc remote add upstream https://github.com/openmv/openmv-doc.git

Set the origin remote of the micropython submodule to the forked micropython repo:

git -C openmv-doc/micropython remote set-url origin https://github.com/<username>/micropython.git

Finally add a remote to openmv-doc's micropython fork:

git -C openmv-doc/micropython remote add upstream https://github.com/openmv/micropython.git

Now the repositories are ready for pull requests. To send a pull request, create a new feature branch and push it to origin, and use Github to create the pull request from the forked repository to the upstream openmv/micropython repository. For example:

git checkout -b <some_branch_name>
<commit changes>
git push origin -u <some_branch_name>

Contribution guidelines

Please follow the best practices when sending pull requests upstream. In general, the pull request should:

  • Fix one problem. Don't try to tackle multiple issues at once.
  • Split the changes into logical groups using git commits.
  • Pull request title should be less than 78 characters, and match this pattern:
    • <scope>:<1 space><description><.>
  • Commit subject line should be less than 78 characters, and match this pattern:
    • <scope>:<1 space><description><.>