Creepso/multi-downloader-nx
1
0
Fork 0
Code Issues 38 Pull requests 10 Projects Releases 70 Packages Wiki Activity Actions

Update README.md

Browse source 
Improve syntax and update build instructions
This commit is contained in:
AnimeDL 2023-07-02 14:48:45 -07:00
parent 3913d9dbe3
commit 190c59d1a9
1 changed files with 11 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
docs/README.md
View file

@ -18,6 +18,7 @@ This application is not endorsed by or affiliated with *Funimation* or *Crunchyr
### Paths Configuration
By default this application uses the following paths to programs (main executables):
* `ffmpeg.exe` (From PATH)
* `mkvmerge.exe` (From PATH)
@ -29,14 +30,18 @@ After installing NodeJS with NPM go to directory with `package.json` file and ty
* [check dependencies](https://david-dm.org/anidl/funimation-downloader-nx)
## CLI Options
See [the documentation](https://github.com/anidl/multi-downloader-nx/blob/master/docs/DOCUMENTATION.md)
## Build instructions
Please note that nodejs and npm must be installed in your system.
Please note that nodejs, npm, and pnpm must be installed in your system. For instructions on how to install pnpm, check (https://pnpm.io/installation)
First clone this repo `git clone https://github.com/anidl/multi-downloader-nx.git`.
`cd` into the cloned directory and run `npm i`.
Afterwards run `npm run tsc false [true if you want gui, false otherwise]`.
If you want the `js` files you are done. Just `cd` into the `lib` folder.
If you want to package the application, please also `cd` into the `lib` folder and run `npx electron-builder build --publish=never [Your Options]` for the gui build. You may find the options [here](https://www.electron.build/cli).
Since the cli tool requires some more configuration, please see the `modules/build.ts` file and run the commands under `buildBinary`.
`cd` into the cloned directory and run `pnpm i`.
Afterwards run `pnpm run tsc false [true if you want gui, false otherwise]`.
If you want the `js` files you are done. Just `cd` into the `lib` folder, and run `node index.js --help` to get started
If you want to package the application, run pnpm run build-`{platform}`-`{type}` where `{platform}` is the operating system (currently the choices are windows, ubuntu, macos, and arm) and `{type}` is cli or gui.