Skip to content

Commit 54ecd2a

Browse files
committed
Update README
1 parent ac4b808 commit 54ecd2a

File tree

1 file changed

+48
-1
lines changed

1 file changed

+48
-1
lines changed

README.md

+48-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,49 @@
1+
![Built with love](http://forthebadge.com/images/badges/built-with-love.svg)
2+
![Kinda SFW](http://forthebadge.com/images/badges/kinda-sfw.svg)
13
# stanford-dl
2-
A dead simple script to download videos or pdfs from Stanford Engineering Everywhere.
4+
5+
A simple multithreaded video/pdf downloader from ***Stanford Engineering Everywhere*** that *just works*.
6+
7+
> NOTE : This tool is to be used strictly for educational purposes.
8+
9+
#### Installation
10+
###### Build from source
11+
12+
```go
13+
go get github.com/coderick14/stanford-dl
14+
```
15+
###### Download compiled binaries
16+
Just download the binary for your required OS and Architecture from [releases](https://github.com/coderick14/stanford-dl/releases).
17+
18+
#### Usage
19+
Type `stanford-dl --help` to get usage details.
20+
```
21+
stanford-dl -course COURSE_CODE [-type {video|pdf}] [-all] [-lec lectures] [--help]
22+
23+
--course Course name e.g. CS229, EE261
24+
--type Specify whether to download videos or pdfs. Defaults to PDF.
25+
--all Download for all lectures
26+
--lec Comma separated list of lectures e.g. 1,3,5,10
27+
--help Display this help message and quit
28+
```
29+
30+
#### Examples
31+
- Get all transcripts (PDFs) for a course
32+
```
33+
stanford-dl -course CS229 -type pdf -all
34+
```
35+
- Get only certain lectures
36+
```
37+
stanford-dl -course CS229 -type pdf -lec 1,3,5,10
38+
```
39+
- Get all videos for a course
40+
```
41+
stanford-dl -course CS229 -type video -all
42+
```
43+
- Get only certain lectures
44+
```
45+
stanford-dl -course CS229 -type video -lec 1,3,5,10
46+
```
47+
48+
#### Contributions
49+
This script has minimum functionality now. PLease feel free to contribute for adding more features :)

0 commit comments

Comments
 (0)