Creepso/multi-downloader-nx_mirror
1
0
Fork 0
mirror of https://github.com/anidl/multi-downloader-nx.git synced 2026-04-21 08:21:56 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source
This commit is contained in:
Izuco 2022-02-24 20:11:56 +01:00 committed by GitHub
parent 599f2572db
commit 9d8488ff24
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
docs/README.md
View file

@ -27,4 +27,14 @@ 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)
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.
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`.