Update the usage section of the readme #4
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Continuous Integration | |
| on: | |
| push: | |
| branches: | |
| - master | |
| pull_request: | |
| branches: | |
| - master | |
| env: | |
| VCPKG_COMMIT: "46e4c4c78c347ded6add526b0c2bb66db35d4710" | |
| jobs: | |
| lint: | |
| runs-on: ubuntu-22.04 | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-python@v5 | |
| with: { python-version: "3.8" } | |
| - name: Install codespell | |
| run: pip3 install codespell | |
| - name: Lint | |
| run: cmake -D FORMAT_COMMAND=clang-format-14 -P cmake/lint.cmake | |
| - name: Spell check | |
| if: always() | |
| run: cmake -P cmake/spell.cmake | |
| docs: | |
| runs-on: ubuntu-22.04 | |
| # To enable, first you have to create an orphaned gh-pages branch: | |
| # | |
| # git switch --orphan gh-pages | |
| # git commit --allow-empty -m "Initial commit" | |
| # git push -u origin gh-pages | |
| # | |
| # Edit the <name> placeholder below to your GitHub name, so this action | |
| # runs only in your repository and no one else's fork. After these, delete | |
| # this comment and the last line in the conditional below. | |
| # If you do not wish to use GitHub Pages for deploying documentation, then | |
| # simply delete this job similarly to the coverage one. | |
| if: github.ref == 'refs/heads/master' | |
| && github.event_name == 'push' | |
| && github.repository_owner == '<name>' | |
| && false | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-python@v5 | |
| with: { python-version: "3.8" } | |
| - name: Install m.css dependencies | |
| run: pip3 install jinja2 Pygments | |
| - name: Install Doxygen | |
| run: sudo apt-get update -q | |
| && sudo apt-get install doxygen -q -y | |
| - name: Build docs | |
| run: cmake "-DPROJECT_SOURCE_DIR=$PWD" "-DPROJECT_BINARY_DIR=$PWD/build" | |
| -P cmake/docs-ci.cmake | |
| - name: Deploy docs | |
| uses: peaceiris/actions-gh-pages@v4 | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: build/docs/html |