Skip to content

Commit

Permalink
docs: Update the documentation on building the documentation (#109)
Browse files Browse the repository at this point in the history
  • Loading branch information
jbmorley authored Jan 18, 2024
1 parent 916a737 commit 2b5d818
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,19 @@ Release builds are created on GitHub Actions using 'build.sh' in the 'scripts' d
It's helpful to be able to manually walk through the full Calendar authorisation flows before release. This authorisation can be reset using the following command, which should allow for testing the first-run experience:

```bash
tccutil reset Calendar uk.co.jbmorley.apps.overview
tccutil reset Calendar uk.co.jbmorley.apps.overview
```

### Documentation

Documentation is built with [Jekyll](https://jekyllrb.com) and deployed at https://overview.jbmorley.co.uk.

Jekyll can be used to serve the documentation locally for testing:

```bash
cd docs
gem install
bundle exec jekyll serve
```

## Licensing
Expand Down

0 comments on commit 2b5d818

Please sign in to comment.