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

2.4 KiB
Raw Blame History

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 for the moment).
  • Get information from any anime (those come from myanimelist.net).
  • More features are to come

This is a software developped with Electron framework. It is still in development.

About OS

  • For the moment, kawAnime fully works only on Mac OS X.
  • On Linux, the download probably won't start but the torrent file will be downloaded. One would find it in KawAnime/resources/tmp directory.
  • The download function doesn't work on Windows. This will most likely be fixed in the end of December.

Installation

Be sure that you have Npm installed. You can find how to install npm (node) here.

git clone https://github.com/Kylart/KawAnime

cd KawAnime/

npm install && 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
  • Optimize main index page.
  • Make a torrent client inside KawAnime.

License

MIT License

Copyright (c) Kylart

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.