File tree 2 files changed +19
-1
lines changed
2 files changed +19
-1
lines changed Original file line number Diff line number Diff line change
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
Original file line number Diff line number Diff line change 1
1
# QCTools Documentation
2
2
3
+ ## Mirror of documentation found within the QCTools GUI application:
4
+
3
5
* [ How To Use] ( /qctools/how_to_use.html )
4
6
* [ Getting Started] ( /qctools/getting_started.html )
5
7
* [ Filter Descriptions] ( /qctools/filter_descriptions.html )
6
8
* [ Playback Filters] ( /qctools/playback_filters.html )
7
9
* [ Recording] ( /qctools/recording.html )
8
- * [ Seattle Municipal Archives User Guide] ( https://github.com/bavc/qctools-documentation/tree/master/SeattleMunicipalArchives )
9
10
* [ 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 )
You can’t perform that action at this time.
0 commit comments