Kylart
/
KawAnime
mirror of https://github.com/Kylart/KawAnime.git
1
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Updated README with all the requirements

This commit is contained in:
Kylart 2019-11-12 14:26:49 +01:00
parent 08530402fa
commit ce17187409
1 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -58,8 +58,11 @@ If you have any problems installing for your OS, you can contact me anytime in t
## Installation ## Installation
Be sure that Npm is installed. You can find how to install npm (node) [here](https://nodejs.org/en/). Be sure that Npm is installed. You can find how to install npm (node) [here](https://nodejs.org/en/).
You will need CMake (v3.12 minimum) to build native dependencies as this project using cmake-js; you can download and install CMake [here](https://cmake.org/download/). Also, you will need a C++ compiler to build native libraries (Clang, GCC and MSVC are all supported).
You will need to have Boost (version 1.65.0 minimum) installed on your system. You can find Boost [here](https://www.boost.org/users/download/). Only `date_time` and `system` libraries are required by this project. You will need to have Boost (version 1.65.0 minimum) installed on your system. You can find Boost [here](https://www.boost.org/users/download/). Only `date_time` and `system` libraries are required by this project.
``` ```
git clone --recursive https://github.com/Kylart/KawAnime git clone --recursive https://github.com/Kylart/KawAnime
``` ```
@ -70,8 +73,15 @@ cd KawAnime/
npm install npm install
``` ```
If `postinstall` script fails, it probably means that you lack one of the requirements listed above. You should install them and retry.
## Run in dev ## Run in dev
##### Build native bindings
```
npm run build:bindings
```
##### Start app ##### Start app
``` ```
npm run dev npm run dev
@ -135,6 +145,9 @@ KawAnime is developed using the following technologies, many thanks to
* [Electron](https://electron.atom.io) * [Electron](https://electron.atom.io)
* [Vue.js](https://vuejs.org) * [Vue.js](https://vuejs.org)
* [Vuetify](https://vuetifyjs.com) * [Vuetify](https://vuetifyjs.com)
* [Libtorrent](https://libtorrent.org)
* [Anitomy](https://github.com/erengy/anitomy)
* [TorrentStream](https://github.com/mafintosh/torrent-stream)
## License ## License
MIT License MIT License