add preview

YanzhaoW · Nov 25, 2024 · d579d36 · d579d36
1 parent 6544394
commit d579d36
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 2 deletions.
diff --git a/.github/workflows/publish_doc.yml b/.github/workflows/publish_doc.yml
@@ -2,7 +2,7 @@ name: publish-doc
 on:
   push:
     branches:
-      - dev
+      - master
   workflow_dispatch:
 
 jobs:

diff --git a/README.md b/README.md
@@ -9,8 +9,11 @@ SRS-DAQ is a project containing a command line tool `srs_control` and additional
 
 Please check the full documentation of this project: [SRS-DAQ documentation](<https://yanzhaow.github.io/srs-daq/>).
 
+## `srs_control` preview
+
+![Imgur](doc/media/srs_control_preview_v1.gif)
 
 ## Acknowledgments
 
 - A lot of information was used from the existing codebase of the VMM slow control software [vmmsc](https://gitlab.cern.ch/rd51-slow-control/vmmsc.git).
-- The understanding of the communication protocol was helped from the [srslib](https://github.com/bl0x/srslib).
+- The understanding of the communication protocol was helped from [srslib](https://github.com/bl0x/srslib).
diff --git a/doc/media/srs_control_preview_v1.gif b/doc/media/srs_control_preview_v1.gif
-Original file line number
+Diff line change
@@ Expand Up / @@ -2,7 +2,7 @@ name: publish-doc @@
     on:
       push:
         branches:
-          - dev
+          - master
       workflow_dispatch:
     jobs:
@@ Expand Down @@