mirror of
https://github.com/FliegendeWurst/KIT-ILIAS-downloader.git
synced 2024-08-28 04:04:18 +00:00
Update readme: .iliasignore usage
This commit is contained in:
parent
e8e81eeb0f
commit
ab9e7f07eb
20
README.md
20
README.md
@ -8,7 +8,7 @@ Download content from ILIAS. That includes:
|
|||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
Go to the [releases](../../releases) and get the executable for your operating system. Alternatively compile from source: (to get the latest updates)
|
Go to the [releases](../../releases) and get the executable for your operating system. Alternatively compile from source: (to get the latest updates)
|
||||||
```sh
|
```
|
||||||
$ git clone https://github.com/FliegendeWurst/KIT-ILIAS-downloader
|
$ git clone https://github.com/FliegendeWurst/KIT-ILIAS-downloader
|
||||||
...
|
...
|
||||||
$ cd KIT-ILIAS-downloader
|
$ cd KIT-ILIAS-downloader
|
||||||
@ -19,10 +19,9 @@ $ cp target/release/KIT-ILIAS-downloader [directory in $PATH]
|
|||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
Use `-o ILIAS` to set the download directory and `-j 5` to speed up the download. Username and password have to be provided every time the program is run.
|
Use `-o <directory>` to specify the download directory. Username and password have to be provided every time the program is run.
|
||||||
You can put a `.iliasignore` in the output directory to skip some courses/folders/files.
|
|
||||||
|
|
||||||
```sh
|
```
|
||||||
$ KIT-ILIAS-downloader --help
|
$ KIT-ILIAS-downloader --help
|
||||||
KIT-ILIAS-downloader 0.2.3
|
KIT-ILIAS-downloader 0.2.3
|
||||||
|
|
||||||
@ -44,7 +43,16 @@ OPTIONS:
|
|||||||
-o, --output <output> Output directory
|
-o, --output <output> Output directory
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### .iliasignore
|
||||||
|
|
||||||
|
.gitignore syntax can be used in a `.iliasignore` file: (located in the download folder)
|
||||||
|
```ignore
|
||||||
|
# example: only download a single course
|
||||||
|
/*/
|
||||||
|
!/InsertNameHere/
|
||||||
|
```
|
||||||
|
|
||||||
## Related programs
|
## Related programs
|
||||||
|
|
||||||
- https://github.com/brantsch/kit-ilias-fuse (synchronous networking and sometimes (?) truncated downloads)
|
- https://github.com/brantsch/kit-ilias-fuse
|
||||||
- https://github.com/Garmelon/PFERD/ (currently in the middle of a rewrite)
|
- https://github.com/Garmelon/PFERD/
|
||||||
|
Loading…
Reference in New Issue
Block a user