Skip to content

Commit

Permalink
[docs] Add link to Discord server.
Browse files Browse the repository at this point in the history
  • Loading branch information
Breakthrough committed Feb 18, 2025
1 parent b8322eb commit f4d36ba
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 5 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ The latest beta of DVR-Scan includes a new GUI. See [the release page](https://

**Documentation**: [dvr-scan.com/docs](https://www.dvr-scan.com/docs/)

**Discord**: [https://discord.gg/UtE6mMSA](https://discord.gg/UtE6mMSA)

------------------------------------------------------

DVR-Scan is a command-line application that **automatically detects motion events in video files** (e.g. security camera footage). DVR-Scan looks for areas in footage containing motion, and saves each event to a separate video clip. DVR-Scan is free and open-source software, and works on Windows, Linux, and Mac.
Expand Down
5 changes: 4 additions & 1 deletion docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -146,4 +146,7 @@ Bug reports can be submitted to the <a href="https://github.com/Breakthrough/DVR

### I have another question...

For technical help, you can try [starting a discussion](https://github.com/Breakthrough/DVR-Scan/discussions) on Github.
For technical help:

- Try [starting a discussion](https://github.com/Breakthrough/DVR-Scan/discussions) on Github
- Ask on the [DVR-Scan Discord server](https://discord.gg/UtE6mMSA)
5 changes: 2 additions & 3 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ hide:

!!! success "Latest Version: 1.6.2 (December 17, 2024)"

<div class="buttongrid">[:fontawesome-solid-download: &nbsp; Download](download.md){ .md-button #download-button }[:fontawesome-solid-book: User Guide](guide.md){ .md-button #changelog-button }[:fontawesome-solid-bars: &nbsp; Documentation](docs.md){ .md-button #documentation-button }[:fontawesome-solid-gear: &nbsp; Resources](changelog.md){ .md-button #quickstart-button }</div>
<div class="buttongrid">[:fontawesome-solid-download: &nbsp; Download](download.md){ .md-button #download-button }[:fontawesome-solid-book: User Guide](guide.md){ .md-button #changelog-button }[:fontawesome-solid-bars: &nbsp; Documentation](docs.md){ .md-button #documentation-button }[:fontawesome-solid-gear: &nbsp; Resources](resources.md){ .md-button #quickstart-button }</div>

------------------------------------------------------

Expand Down Expand Up @@ -41,6 +41,5 @@ Use `ffmpeg` to extract events:

dvr-scan -i video.mp4 -m ffmpeg

Once installed, see [the user guide](guide.md) to get started, try one of the examples above, or type `dvr-scan --help`. Press `Ctrl + C` to stop processing at any time.
Once installed, see [the user guide](guide.md) to get started, try one of the examples above, or type `dvr-scan --help`. Press `Ctrl + C` to stop processing at any time. See the [documentation](docs.md) for a complete description of all [command-line](docs.md#dvr-scan-options) and [config file](docs.md#config-file) settings.

See the [documentation](docs.md) for a complete description of all [command-line](docs.md#dvr-scan-options) and [config file](docs.md#config-file) settings.
9 changes: 8 additions & 1 deletion docs/resources.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,20 @@

------------------------------------------------

## :fontawesome-solid-link:Links

- Github: [https://github.com/Breakthrough/DVR-Scan](https://github.com/Breakthrough/DVR-Scan)
- Discord: [https://discord.gg/UtE6mMSA](https://discord.gg/UtE6mMSA)

------------------------------------------------

## :fontawesome-solid-bug:Bug Reports

Bugs and issues with DVR-Scan are handled through [the issue tracker on Github](https://github.com/Breakthrough/DVR-Scan/issues?q=). If you encounter into any bugs while using DVR-Scan, please feel free to [create a new issue](https://github.com/Breakthrough/DVR-Scan/issues/new) describing the problem.

Make sure to set `--verbosity debug` when attaching program logs. Attach examples where possible to demonstrate the problem. Include any information you think is relevant to replicate and resolve the issue.

For technical help, you can try [starting a discussion](https://github.com/Breakthrough/DVR-Scan/discussions) on Github.
For technical help, you can try [starting a discussion](https://github.com/Breakthrough/DVR-Scan/discussions) on Github or joining the [DVR-Scan Discord server](https://discord.gg/UtE6mMSA).

------------------------------------------------

Expand Down

0 comments on commit f4d36ba

Please sign in to comment.