Create README.md

This commit is contained in:
Zoe Roux 2020-12-28 16:15:31 +01:00
parent a6d3107329
commit dc288baa57

19
README.md Normal file
View File

@ -0,0 +1,19 @@
# Kyoo
Kyoo is an open-souce media browser which allow you to stream your movies, tv-shows or animes.
It is an alternative to Plex, Emby or Jellyfin.
Kyoo has been created from scratch, it is not a fork. Everything is and always will be free and open-source.
Feel free to open issues or pull requests, all contribution are welcomed.
## Repositories
This is the main repository for Kyoo. Here, you will find all the server's code, the build process & the login page.
In the ![Kyoo.WebApp](https://github.com/AnonymusRaccoon/Kyoo.WebApp) repository, you will find the code of the web app (created usint angular).
In the ![Kyoo.transcoder](https://github.com/AnonymusRaccoon/Kyoo.transcoder) repository, you will find the C code that handle transcoding, transmuxing & subtitles/codecs extractions from media files.
Both of theses repository are needed to fully build Kyoo, when you clone this repository you should use the --recurse argument of git like so: ```git clone https://github.com/AnonymusRaccoon/Kyoo --recurse```.