Skip to content

Contributing

Development Setup

git clone https://github.com/mathieucarbou/MycilaTaskManager.git
cd MycilaTaskManager
pio run

The examples are compiled by switching src_dir in platformio.ini:

[platformio]
lib_dir = .
src_dir = examples/TaskManager   ; AsyncTaskManager, Json or Watchdog

Building the Documentation

The website is built with MkDocs and the Material theme. The C++ API is generated by Doxygen through the mkdoxy plugin.

python3 -m venv venv
source venv/bin/activate
pip install mkdocs-material mkdoxy

mkdocs serve   # local preview on http://127.0.0.1:8000
mkdocs build   # static site in ./site

doxygen must be installed and on your PATH for the cppapi section to be generated.

Submitting Changes

  1. Fork the repository
  2. Create a feature branch: git checkout -b feature/my-feature
  3. Commit your changes: git commit -m 'Add my feature'
  4. Push to the branch: git push origin feature/my-feature
  5. Open a Pull Request

License

This project is licensed under the MIT License — see the LICENSE file for details.

Disclaimer

This website is provided for informational purposes only. By accessing this site and using the information contained herein, you accept the terms set forth in this disclaimer.

  • Accuracy of Information: We strive to provide accurate and up-to-date information on this site, but we cannot guarantee the completeness or accuracy of this information. The information provided is subject to change without notice.

  • Use of Information: Use of the information provided on this site is at your own risk. We decline all responsibility for the consequences arising from the use of this information. It is recommended that you consult a competent professional for advice specific to your situation.

  • External Links: This site may contain links to external websites which are provided for your reference and convenience. We have no control over the content of these external sites and we accept no responsibility for their content and their use.

  • Limitation of Liability: To the fullest extent permitted by applicable law, we disclaim all liability for any direct, indirect, incidental, consequential or special damages arising out of the use of, or inability to use, this website, even if we have been advised of the possibility of such damage.

By using this site, you agree to hold harmless the owners, administrators and authors of this site from any claims arising from your use of this website. If you do not agree to these terms, please do not use this site.

Author: Mathieu Carbou