mirror of https://github.com/Kylart/KawAnime.git
54 lines
1.2 KiB
Markdown
54 lines
1.2 KiB
Markdown
# _KawAnime_
|
|
|
|
Disclaimer : This is a software for otaku/anime-fans. Do not try if you're not prepared.
|
|
|
|
This software allows one to:
|
|
* Be aware of the latest anime release.
|
|
* Download an anime via Torrent (one would need a torrent client).
|
|
* Get information from any anime (those come from myanimelist.net).
|
|
* Get anime-related news from MyAnimeList.net.
|
|
* Get seasonal releases information.
|
|
* More features are to come.
|
|
|
|
This is a software developed with Electron framework. It is still in development.
|
|
|
|
## About OS
|
|
_KawAnime_ is completely cross-platform
|
|
|
|
Yet, if you find any problem, you can tell me anytime in the `issues` section.
|
|
|
|
## Installation
|
|
Be sure that you have Npm installed. You can find how to install npm (node) [here](https://nodejs.org/en/).
|
|
```
|
|
git clone https://github.com/Kylart/KawAnime
|
|
```
|
|
```
|
|
cd KawAnime/
|
|
```
|
|
```
|
|
npm install && npm start
|
|
```
|
|
|
|
## Start
|
|
```
|
|
npm start
|
|
```
|
|
|
|
|
|
## Contributing
|
|
1. Fork it!
|
|
2. Create your feature branch: `git checkout -b my-new-feature`
|
|
3. Commit your changes: `git commit -am 'Add some feature'`
|
|
4. Push to the branch: `git push origin my-new-feature`
|
|
5. Submit a pull request.
|
|
|
|
## TODOs
|
|
* Make a better design.
|
|
* Make _KawAnime_ completlely responsive
|
|
|
|
## License
|
|
MIT License
|
|
|
|
Copyright (c) Kylart
|
|
|