Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

docs: Update the documentation on building the documentation #109

Merged
merged 1 commit into from
Jan 18, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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