Skip to content

Commit 6dcbca9

Browse files
committed
adds README for using /docs folder and updates web index with links to cheatsheet, avaa
1 parent 38bb3ec commit 6dcbca9

File tree

2 files changed

+19
-1
lines changed

2 files changed

+19
-1
lines changed

docs/README.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# View documentation online
2+
3+
## [http://bavc.github.io/qctools/](http://bavc.github.io/qctools/)
4+
5+
# View documentation locally
6+
7+
* Clone this repository and open the directory
8+
* `cd docs/` folder
9+
* install [Jekyll](https://jekyllrb.com/) (`gem install jekyll bundler`)
10+
* `bundle install` to install necessary dependencies
11+
* `jekyll serve` (or `bundle exec jekyll serve`) to run the server

docs/index.md

+8-1
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,16 @@
11
# QCTools Documentation
22

3+
## Mirror of documentation found within the QCTools GUI application:
4+
35
* [How To Use](/qctools/how_to_use.html)
46
* [Getting Started](/qctools/getting_started.html)
57
* [Filter Descriptions](/qctools/filter_descriptions.html)
68
* [Playback Filters](/qctools/playback_filters.html)
79
* [Recording](/qctools/recording.html)
8-
* [Seattle Municipal Archives User Guide](https://github.com/bavc/qctools-documentation/tree/master/SeattleMunicipalArchives)
910
* [SignalServer Integration](/qctools/signalserverintegration.html)
11+
12+
## Supplemental, web-based documentation
13+
14+
* [A/V Artifact Atlas](https://bavc.github.io/avaa/)
15+
* [QCTools Cheat Sheet](https://docs.google.com/document/d/1xat34KWmMwmz8lzXPUACItPdGFR_kBv43Vu6Qkeaov4)
16+
* [Seattle Municipal Archives User Guide](https://github.com/bavc/qctools-documentation/tree/master/SeattleMunicipalArchives)

0 commit comments

Comments
 (0)