Skip to content

Commit 17f1979

Browse files
cliticclitic
committed
updated docs
1 parent 8be9d19 commit 17f1979

10 files changed

Lines changed: 162 additions & 153 deletions

File tree

‎.github/workflows/docs.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Documentation
1+
name: docs
22

33
on:
44
workflow_dispatch:

‎docs/android.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@ icon: fontawesome/brands/android
44

55
# Android Support
66

7-
1. Install the [Termux](https://termux.com) app on your device, then enable storage permissions manually from its settings page. After that, run the following commands in the terminal.
7+
1. Install the [Termux](https://f-droid.org/en/packages/com.termux) app on your device, then enable storage permissions manually from its settings page. After that, run the following commands in the terminal.
88

99
```bash
10-
$ pkg update
11-
$ pkg upgrade
12-
$ pkg install ffmpeg
13-
$ ln -s /storage/emulated/0/Download Download
10+
pkg update
11+
pkg upgrade
12+
pkg install ffmpeg
13+
ln -s /storage/emulated/0/Download Download
1414
```
1515

1616
2. Install [vsd on termux](https://github.com/clitic/vsd/blob/main/vsd/BUILD.md#android-on-termux). Currently, only *arm64-v8a* binaries pre-builts are available which can be installed using the following command.
@@ -24,6 +24,6 @@ icon: fontawesome/brands/android
2424
4. Now you can run vsd as usual. The streams would be directly downloaded in your android downloads folder.
2525

2626
```bash
27-
$ cd Download
28-
$ vsd save <url> -o video.mp4
27+
cd Download
28+
vsd save <url> -o video.mp4
2929
```

‎docs/assets/paypal.svg‎

Lines changed: 24 additions & 0 deletions
Loading

‎docs/build.md‎

Lines changed: 37 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -36,21 +36,21 @@ cargo run -p vsd --example vsd-docs --all-features
3636
1. Install [Android NDK](https://developer.android.com/ndk/downloads).
3737

3838
```bash
39-
$ wget https://dl.google.com/android/repository/android-ndk-r27c-linux.zip
40-
$ unzip android-ndk-r27c-linux.zip
41-
$ rm android-ndk-r27c-linux.zip
39+
wget https://dl.google.com/android/repository/android-ndk-r27c-linux.zip
40+
unzip android-ndk-r27c-linux.zip
41+
rm android-ndk-r27c-linux.zip
4242
```
4343

4444
2. Add rustup *aarch64-linux-android* target.
4545

4646
```bash
47-
$ rustup target add aarch64-linux-android
47+
rustup target add aarch64-linux-android
4848
```
4949

5050
3. Now build with *aarch64-linux-android target*. `rpath` link arg can be removed if you do not want to support termux. You can also use [cargo-ndk](https://github.com/bbqsrc/cargo-ndk) to build vsd.
5151

5252
```bash
53-
$ PATH=$HOME/android-ndk-r27c/toolchains/llvm/prebuilt/linux-x86_64/bin:$PATH \
53+
PATH=$HOME/android-ndk-r27c/toolchains/llvm/prebuilt/linux-x86_64/bin:$PATH \
5454
AR=llvm-ar \
5555
CC=aarch64-linux-android25-clang \
5656
CXX=aarch64-linux-android25-clang++ \
@@ -61,46 +61,46 @@ cargo run -p vsd --example vsd-docs --all-features
6161
4. Inspect for linked libraries.
6262

6363
```bash
64-
$ llvm-readelf target/aarch64-linux-android/release/vsd --needed-libs
64+
llvm-readelf target/aarch64-linux-android/release/vsd --needed-libs
6565
```
6666

6767
## Android (On Termux)
6868

6969
```bash
70-
$ pkg update
71-
$ pkg upgrade
72-
$ pkg install cmake git protobuf rust
73-
$ git clone https://github.com/clitic/vsd --depth 1
74-
$ cd vsd
75-
$ AR=llvm-ar \
70+
pkg update
71+
pkg upgrade
72+
pkg install cmake git protobuf rust
73+
git clone https://github.com/clitic/vsd --depth 1
74+
cd vsd
75+
AR=llvm-ar \
7676
OPENSSL_INCLUDE_DIR=$PREFIX/include/openssl
7777
OPENSSL_LIB_DIR=$PREFIX/lib \
7878
OPENSSL_NO_VENDOR=true \
79-
cargo build -p vsd --release --no-default-features --features "native-tls"
79+
cargo build -p vsd --release --no-default-features --features "capture,license,native-tls"
8080
```
8181

8282
## Darwin (On Linux via osxcross)
8383

8484
1. Install [osxcross](https://github.com/tpoechtrager/osxcross) toolchain.
8585

8686
```bash
87-
$ git clone https://github.com/tpoechtrager/osxcross
88-
$ curl -L https://github.com/joseluisq/macosx-sdks/releases/download/15.4/MacOSX15.4.sdk.tar.xz -o osxcross/tarballs/MacOSX15.4.sdk.tar.xz
89-
$ cd osxcross
90-
$ sudo apt install bzip2 clang cmake cpio git libssl-dev libxml2-dev llvm-dev lzma-dev patch python3 uuid-dev zlib1g-dev xz-utils
91-
$ UNATTENDED=1 ./build.sh
87+
git clone https://github.com/tpoechtrager/osxcross
88+
curl -L https://github.com/joseluisq/macosx-sdks/releases/download/15.4/MacOSX15.4.sdk.tar.xz -o osxcross/tarballs/MacOSX15.4.sdk.tar.xz
89+
cd osxcross
90+
sudo apt install bzip2 clang cmake cpio git libssl-dev libxml2-dev llvm-dev lzma-dev patch python3 uuid-dev zlib1g-dev xz-utils
91+
UNATTENDED=1 ./build.sh
9292
```
9393

9494
2. Add rustup *aarch64-apple-darwin* target.
9595

9696
```bash
97-
$ rustup target add aarch64-apple-darwin
97+
rustup target add aarch64-apple-darwin
9898
```
9999

100100
3. Now build with *aarch64-apple-darwin* target.
101101

102102
```bash
103-
$ PATH=$HOME/osxcross/target/bin:$PATH \
103+
PATH=$HOME/osxcross/target/bin:$PATH \
104104
AR=aarch64-apple-darwin24.4-ar \
105105
CC=aarch64-apple-darwin24.4-clang \
106106
CXX=aarch64-apple-darwin24.4-clang++ \
@@ -112,36 +112,36 @@ $ AR=llvm-ar \
112112
4. Inspect for linked libraries.
113113

114114
```bash
115-
$ llvm-readobj target/aarch64-apple-darwin/release/vsd --macho-version-min --needed-libs
115+
llvm-readobj target/aarch64-apple-darwin/release/vsd --macho-version-min --needed-libs
116116
```
117117

118118
## Linux with MUSL (On Linux)
119119

120120
1. Build and install musl cross toolchain using [musl-cross-make](https://github.com/richfelker/musl-cross-make).
121121

122122
```bash
123-
$ git clone https://github.com/richfelker/musl-cross-make --depth 1
124-
$ cd musl-cross-make
125-
$ TARGET=x86_64-linux-musl make install
123+
git clone https://github.com/richfelker/musl-cross-make --depth 1
124+
cd musl-cross-make
125+
TARGET=x86_64-linux-musl make install
126126
```
127127

128128
2. Find and delete *libstdc++.so* for static linking else keep it.
129129

130130
```bash
131-
$ find musl-cross-make/output/**/*/libstdc++.so*
132-
$ rm musl-cross-make/output/**/*/libstdc++.so*
131+
find musl-cross-make/output/**/*/libstdc++.so*
132+
rm musl-cross-make/output/**/*/libstdc++.so*
133133
```
134134

135135
3. Add rustup *x86_64-unknown-linux-musl* target.
136136

137137
```bash
138-
$ rustup target add x86_64-unknown-linux-musl
138+
rustup target add x86_64-unknown-linux-musl
139139
```
140140

141141
4. Now build with *x86_64-unknown-linux-musl* target.
142142

143143
```bash
144-
$ PATH=$HOME/musl-cross-make/output/bin:$PATH \
144+
PATH=$HOME/musl-cross-make/output/bin:$PATH \
145145
AR=x86_64-linux-musl-ar \
146146
CC=x86_64-linux-musl-gcc \
147147
CXX=x86_64-linux-musl-g++ \
@@ -152,59 +152,59 @@ $ AR=llvm-ar \
152152
5. Inspect for linked libraries.
153153

154154
```bash
155-
$ PATH=$HOME/musl-cross-make/output/bin:$PATH x86_64-linux-musl-readelf target/x86_64-unknown-linux-musl/release/vsd --dynamic
155+
PATH=$HOME/musl-cross-make/output/bin:$PATH x86_64-linux-musl-readelf target/x86_64-unknown-linux-musl/release/vsd --dynamic
156156
```
157157

158158
## Linux with MUSL (On Linux via cargo-zigbuild)
159159

160160
1. Install [zig](https://ziglang.org/download) and [cargo-zigbuild](https://github.com/rust-cross/cargo-zigbuild).
161161

162162
```bash
163-
$ cargo install cargo-zigbuild
163+
cargo install cargo-zigbuild
164164
```
165165

166166
2. Add rustup *x86_64-unknown-linux-musl* target.
167167

168168
```bash
169-
$ rustup target add x86_64-unknown-linux-musl
169+
rustup target add x86_64-unknown-linux-musl
170170
```
171171

172172
3. Now build with *x86_64-unknown-linux-musl* target using cargo-zigbuild.
173173

174174
```bash
175-
$ cargo zigbuild -p vsd --release --target x86_64-unknown-linux-musl
175+
cargo zigbuild -p vsd --release --target x86_64-unknown-linux-musl
176176
```
177177

178178
5. Inspect for linked libraries.
179179

180180
```bash
181-
$ llvm-readelf target/x86_64-unknown-linux-musl/release/vsd --needed-libs
181+
llvm-readelf target/x86_64-unknown-linux-musl/release/vsd --needed-libs
182182
```
183183

184184
## Windows with MSVC (On Linux via cargo-xwin)
185185

186186
1. Install [cargo-xwin](https://github.com/rust-cross/cargo-xwin).
187187

188188
```bash
189-
$ cargo install cargo-xwin
189+
cargo install cargo-xwin
190190
```
191191

192192
2. Add rustup *x86_64-pc-windows-msvc* target.
193193

194194
```bash
195-
$ rustup target add x86_64-pc-windows-msvc
195+
rustup target add x86_64-pc-windows-msvc
196196
```
197197

198198
3. Now build with *x86_64-pc-windows-msvc* target using cargo-xwin.
199199

200200
```bash
201-
$ cargo xwin build -p vsd --release --target x86_64-pc-windows-msvc
201+
cargo xwin build -p vsd --release --target x86_64-pc-windows-msvc
202202
```
203203

204204
5. Inspect for linked libraries.
205205

206206
```bash
207-
$ llvm-readelf target/x86_64-pc-windows-msvc/release/vsd.exe --needed-libs
207+
llvm-readelf target/x86_64-pc-windows-msvc/release/vsd.exe --needed-libs
208208
```
209209

210210
[reqwest]: https://docs.rs/reqwest/latest/reqwest/#optional-features

‎docs/cli.md‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,10 +48,12 @@ vsd [OPTIONS] <COMMAND>
4848
Capture playlists and subtitles requests from a website.
4949

5050
Requires one of the following browsers to be installed:
51-
* chrome - https://www.google.com/chrome
52-
* chromium - https://www.chromium.org/getting-involved/download-chromium
51+
52+
- chrome - https://www.google.com/chrome
53+
- chromium - https://www.chromium.org/getting-involved/download-chromium
5354

5455
This command launches an automated browser instance and listen on requests. Behavior may vary, and it may not work as expected on all websites. This is equivalent to manually doing:
56+
5557
Inspect -> Network -> Fetch/XHR -> Filter by extension -> Copy as cURL (bash)
5658

5759
```

docs/home.md renamed to docs/index.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
icon: lucide/house
33
---
44

5-
<h1 align="center">vsd</h1>
5+
# VSD
66

77
[![Github Downloads](https://img.shields.io/github/downloads/clitic/vsd/total?logo=github&style=flat-square)](https://github.com/clitic/vsd/releases)
88
[![Crate Downloads](https://img.shields.io/crates/d/vsd?logo=rust&style=flat-square)](https://crates.io/crates/vsd)
@@ -20,6 +20,9 @@ icon: lucide/house
2020
<a href="https://www.buymeacoffee.com/clitic" target="_blank">
2121
<img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" width="150px">
2222
</a>
23+
<a href="https://paypal.me/clitic" target="_blank">
24+
<img src="https://raw.githubusercontent.com/clitic/vsd/refs/heads/main/docs/assets/paypal.svg" alt="PayPal" width="150px">
25+
</a>
2326
</div>
2427

2528
## Features
@@ -30,5 +33,5 @@ icon: lucide/house
3033
- [x] Muxing streams to single video container using ffmpeg.
3134
- [x] Offers robust automation support.
3235
- [x] One unified progress bar tracking the entire download, with real-time file size updates.
33-
- [x] Supports decryption for `AES-128`, `SAMPLE-AES`, `CENC`, `CBCS`, `CENS` and `CBC1`.
34-
- [ ] Live stream downloading (not currently planned). Consider [contributing](https://github.com/clitic/vsd/fork) this feature.
36+
- [x] Supports decryption for `AES-128`, `SAMPLE-AES`, `CENC`, `CENS`, `CBC1` and `CBCS`.
37+
- [ ] Live stream downloading, consider [contributing](https://github.com/clitic/vsd/fork) this feature.

‎docs/install.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ Finally, add that directory to your system's `PATH` environment variable.
6969

7070
=== ":fontawesome-brands-android: Android"
7171

72-
Requires [Termux](https://f-droid.org/en/packages/com.termux). Downloads and extracts the binary to $PREFIX/bin.
72+
Requires [Termux](https://f-droid.org/en/packages/com.termux). Downloads and extracts the binary to `$PREFIX/bin`. See [android support](https://clitic.github.io/vsd/android) for more details.
7373

7474
=== "arm64"
7575

@@ -82,5 +82,5 @@ Finally, add that directory to your system's `PATH` environment variable.
8282
You can also install vsd using cargo.
8383

8484
```bash
85-
$ cargo install vsd
85+
cargo install vsd
8686
```

0 commit comments

Comments
 (0)