aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMelody Horn <melody@boringcactus.com>2019-02-27 01:07:17 -0700
committerMelody Horn <melody@boringcactus.com>2019-02-27 01:07:17 -0700
commit2b8cdab87de88d41dc0df4ee1ee7f434bf454cab (patch)
treedfc746d6d70c511bedc802ef21216d605619f44c
parent14eff99bc22d5266784e7201e7680277c0fcf2f9 (diff)
downloadvidslice-2b8cdab87de88d41dc0df4ee1ee7f434bf454cab.tar.gz
vidslice-2b8cdab87de88d41dc0df4ee1ee7f434bf454cab.zip
add better instructions in README
-rw-r--r--README.md20
1 files changed, 17 insertions, 3 deletions
diff --git a/README.md b/README.md
index b2cbb48..b88457d 100644
--- a/README.md
+++ b/README.md
@@ -5,6 +5,20 @@ video manipulator wrapping youtube-dl and ffmpeg
![screenshot of vidslice demonstrating options](screenshot.png)
## Installing
-Download the .zip for your preferred OS [here](https://github.com/boringcactus/vidslice/releases/latest).
-You may also need to [download ffmpeg](https://ffmpeg.org/download.html#get-packages) (if you're on Windows, you want Windows Builds and then the default options are fine) and [download youtube-dl](https://rg3.github.io/youtube-dl/download.html).
-Both of those will give you some executables; you can place them in the same folder as your downloaded vidslice.exe and that should work.
+1. Download the .zip for your preferred OS [here](https://github.com/boringcactus/vidslice/releases/latest) and extract it somewhere convenient.
+2. If you don't have it already, [download ffmpeg](https://ffmpeg.org/download.html#get-packages) (if you're on Windows, you want Windows Builds and then the default options are fine) and make sure ffmpeg.exe, ffprobe.exe, and ffplay.exe are all next to vidslice.exe (or however that'll work on a Mac, hit me up if you have an explanation for this).
+3. If you want to be able to download things, [download youtube-dl](https://rg3.github.io/youtube-dl/download.html) and put it in the same place as ffmpeg.
+
+## Using
+If you already have a video file in a format supported by ffmpeg (which is most of them), you can use the "Browse" button in the Sources panel to load in your video.
+If you want to download something from YouTube or anywhere else listed [here](https://rg3.github.io/youtube-dl/supportedsites.html), paste the URL in the URL box and hit "Download".
+
+Properties of the video are listed in the Options panel; you can check the Edit box for a property to set a new value for it.
+You can't edit all three time fields, since two of them together always determine the third one.
+
+The Output panel lets you specify where you want the output to go.
+You can use any format ffmpeg supports.
+If you're creating a .gif, you'll likely want to check the "Improve GIF" box.
+For a silent video, which is just a better GIF as far as platforms like Telegram are concerned, check the "Silence" box.
+
+The "Run" button will simply run the conversion; "Run & Preview" will show your output afterwards; "Run & Quit" will quit vidslice afterwards.