/CVRFury-Docs

Primary LanguageRubyGNU Lesser General Public License v2.1LGPL-2.1

Contributors Forks Stargazers Issues LGPL2 License


CVR Fury Docs


Report Bug · Request Feature

Table of Contents
  1. Local build of docs site (for development)
  2. Contributing
  3. License
  4. Project tools

Local build of docs site (for development)

This docs site use jekyll

To run this locally you need to install ruby and the jekyll ruby gem, please refer to the official jekyll install guide for instructions

To start the local copy of the site use the command jekyll serve in the root of this repository

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are appreciated. Please see CONTRIBUTING.md for more details.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Please see LICENSE for information.

(back to top)

Project tools

  • VS Code, ide
  • Pre-Commit, linting and error detection
  • Github Copilot, Code error/issue analysis

(back to top)