docs: revamp README.md #48
This file contains hidden or 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: | |
| - main | |
| paths-ignore: | |
| - "**/README.md" | |
| pull_request: | |
| workflow_dispatch: | |
| env: | |
| CARGO_TERM_COLOR: always | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| jobs: | |
| checks: | |
| name: Checks | |
| runs-on: ubuntu-latest | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| action: | |
| - command: build | |
| target: x86_64-unknown-linux-gnu | |
| working-dir: tuitar | |
| - command: build | |
| target: xtensa-esp32-espidf | |
| working-dir: firmware | |
| - command: clippy | |
| args: -- -D warnings | |
| target: x86_64-unknown-linux-gnu | |
| working-dir: tuitar | |
| - command: clippy | |
| args: -- -D warnings | |
| target: xtensa-esp32-espidf | |
| working-dir: firmware | |
| - command: test | |
| target: x86_64-unknown-linux-gnu | |
| working-dir: ratatui-fretboard | |
| - command: test | |
| target: x86_64-unknown-linux-gnu | |
| working-dir: tuitar-core | |
| steps: | |
| - name: Install dependencies | |
| run: | | |
| sudo apt-get update | |
| sudo apt-get install -y \ | |
| --no-install-recommends \ | |
| --allow-unauthenticated \ | |
| libasound2-dev | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| - name: Setup Rust | |
| uses: esp-rs/xtensa-toolchain@v1.5 | |
| with: | |
| default: true | |
| buildtargets: esp32 | |
| ldproxy: true | |
| - name: Enable caching | |
| uses: Swatinem/rust-cache@v2 | |
| - name: Run command | |
| run: | | |
| cd ${{ matrix.action.working-dir || '.' }} | |
| cargo ${{ matrix.action.command }} --target ${{ matrix.action.target || 'x86_64-unknown-linux-gnu' }} ${{ matrix.action.args || '' }} | |
| format: | |
| name: Format | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| - name: Setup Rust | |
| uses: esp-rs/xtensa-toolchain@v1.5 | |
| with: | |
| default: true | |
| buildtargets: esp32 | |
| ldproxy: true | |
| - name: Run formatter | |
| run: cargo fmt --all -- --check --color always |