diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..26760a5 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,10 @@ +root = true + +[*] +insert_final_newline = true +end_of_line = lf + +[*.{md,cs}] +indent_style = space +indent_size = 4 +charset = utf-8 diff --git a/Documentation/Installation.md b/Documentation/Installation.md new file mode 100644 index 0000000..a2fe233 --- /dev/null +++ b/Documentation/Installation.md @@ -0,0 +1,24 @@ + +# Installation + +*How to setup this program.* + +
+ +## Steps + +
+ +1. **[Download]** a Release. + +
+ +2. [Install **FFMPEG** & **FFPROBE**][FFMPEG] + +
+ + + + +[Download]: https://github.com/NotBoogie/Stream-Video-Merger/releases +[FFMPEG]: https://www.wikihow.com/Install-FFmpeg-on-Windows diff --git a/Documentation/Usage.md b/Documentation/Usage.md new file mode 100644 index 0000000..c8b26b5 --- /dev/null +++ b/Documentation/Usage.md @@ -0,0 +1,25 @@ + +# Usage + +
+ +## Basics + +Drag your **OBS** recordings onto the
+executable to have them combined. + +
+
+ +## Settings + +Control the resulting file type, as well as whether
+or not a zip / webm should be generated in your
+ +`settings.json`  + +
+ +*This file will automatically be generated will default values.* + +
diff --git a/README.md b/README.md index 9d90ae0..e5d7f87 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,48 @@ -# Stream-Video-Merger -Automates combining stream recordings into one long video and .zips it for you. Drag OBS recordings into .exe to create. -Control the result file type, zip, and webm generation in the settings.json file. settings.json will be created with default options on first execution (if one isn't found) +
-Requires FFMPEG.exe and FFPROBE.exe to be in your PATH. ( https://www.wikihow.com/Install-FFmpeg-on-Windows explains setup better than I could) +
-Derivative of FUSER project. +![Badge .Net]    +![Badge Based] -Runs on .net 5.0 +
+ +# Stream Video Merger + +*Automates combining stream recordings*
+*into one long video, as well as zipping it.* + +
+
+ +[![Button Download]][Download] + +[![Button Install]][Install] + +[![Button Usage]][Usage] + +
+ +
+ + + + +[Download]: https://github.com/NotBoogie/Stream-Video-Merger/releases + +[Install]: Documentation/Installation.md +[Usage]: Documentation/Usage.md + + + + +[Badge Based]: https://img.shields.io/badge/Based_On-FUSER-415986?style=for-the-badge&logoColor=white&labelColor=5879b5&logo=Puppet +[Badge .Net]: https://img.shields.io/badge/-5.0-418643?style=for-the-badge&logoColor=white&labelColor=53AC56&logo=.NET + + + + +[Button Download]: https://img.shields.io/badge/Download-b51d5a?style=for-the-badge&logoColor=white&logo=DocuSign +[Button Install]: https://img.shields.io/badge/Installation-5879b5?style=for-the-badge&logoColor=white&logo=GitBook +[Button Usage]: https://img.shields.io/badge/Usage-53ac56?style=for-the-badge&logoColor=white&logo=BookStack