Mirrored_Repos/obs-websocket
1
0
Fork 0
mirror of https://github.com/Palakis/obs-websocket.git synced 2024-08-30 18:12:16 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Add big text to README in the docs directory linking protocol.md

Browse Source 
I bet people have been getting confused here
This commit is contained in:
tt2468 2023-05-27 22:14:16 -07:00
parent 2caecf6c01
commit 2606f262e6
1 changed files with 2 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/README.md
View File

@ -1,5 +1,7 @@
# obs-websocket documentation
## If you're looking for the documentation page, it's [here](docs/generated/protocol.md)
This is the documentation for obs-websocket. Run `build_docs.sh` to auto generate the latest docs from the `src` directory. There are 3 components to the docs generation:
- `comments/comments.js`: Generates the `work/comments.json` file from the code comments in the src directory.