From dc288baa576ea78f8a3a0bea2feb743480a660a9 Mon Sep 17 00:00:00 2001 From: Zoe Roux Date: Mon, 28 Dec 2020 16:15:31 +0100 Subject: [PATCH] Create README.md --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 00000000..6c8470b2 --- /dev/null +++ b/README.md @@ -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```. +