From 060d2f1b19c0f6256b84c79ca14596e032ff744f Mon Sep 17 00:00:00 2001 From: Anthony Lavado Date: Mon, 17 Dec 2018 03:10:15 -0500 Subject: [PATCH 1/3] Complete overhaul of README - Moves all build/package information to Wiki - Adds new badges for quick info - Adds new styles, and looks good on mobile --- README.md | 109 ++++++++++++++++++++++-------------------------------- 1 file changed, 44 insertions(+), 65 deletions(-) diff --git a/README.md b/README.md index 1a19df56c..51a6d5db2 100644 --- a/README.md +++ b/README.md @@ -1,76 +1,55 @@ -Jellyfin -============ +

Jellyfin

+

The Free Software Media System

-Jellyfin is a personal media server. The Jellyfin project was started as a result of Emby's decision to take their code closed-source, as well as various philosophical differences with the core developers. Jellyfin seeks to be the free software alternative to Emby and Plex to provide media management and streaming from a dedicated server to end-user devices. +

+Jellyfin is a free software media system that puts you in control of managing and streaming your media. +

+ +----- + +

+Want to get started? Choose from Prebuilt Packages, or Build from Source. +

+

+Want to contribute? Check out our wiki for guidelines. +

+ +--- + +

+GPL 2.0 License +Build Status +Docker Pull Count +Chat on Matrix +Join our Subreddit +

+ +For further details, please see [our wiki](https://github.com/jellyfin/jellyfin/wiki). + +To receive the latest project updates feel free to join [our public chat on Matrix/Riot](https://matrix.to/#/#jellyfin:matrix.org), and follow us on [Social Media](https://github.com/jellyfin/jellyfin/wiki/Social-Media). + +## About + +The Jellyfin project was started as a result of Emby's decision to take their code closed-source, as well as various philosophical differences with the core developers. Jellyfin seeks to be the free software alternative to Emby and Plex to provide media management and streaming from a dedicated server to end-user devices. Jellyfin is descended from Emby 3.5.2, ported to the .NET Core framework, and aims to contain build facilities for every platform. -For further details, please see [our wiki](https://github.com/jellyfin/jellyfin/wiki). To receive the latest project updates feel free to join [our public chat on Matrix/Riot](https://matrix.to/#/#jellyfin:matrix.org) and to subscribe to [our subreddit](https://www.reddit.com/r/jellyfin/). +## Issues and Feature Requests -## Feature Requests -While our first priority is a stable build, we will eventually add features that were missing in Emby or were not well implemented (technically or philosophically). -[Feature Requests](http://feathub.com/jellyfin/jellyfin) +

+New idea or improvement? +
+Open a Feature Request. +

+

+Something not working right? +
+Open an Issue. +

+ ## Contributing to Jellyfin If you're interested in contributing, please see [our wiki for guidelines](https://github.com/jellyfin/jellyfin/wiki/Contributing-to-Jellyfin). - -## Prebuilt Jellyfin packages - -Prebuild packages are available for Debian/Ubuntu and Arch, and via Docker Hub. - -### Docker - -The Jellyfin Docker image is available on Docker Hub at https://hub.docker.com/r/jellyfin/jellyfin/ - -### Arch - -The Jellyfin package is in the AUR at https://aur.archlinux.org/packages/jellyfin-git/ - -### Unraid - -An Unraid Docker template is available. See [this documentation page](https://github.com/jellyfin/jellyfin/blob/master/unRaid/docker-templates/README.md) for details on installing it. - -### Debian/Ubuntu - -A package repository is available at https://repo.jellyfin.org. - -NOTE: Ubuntu users may find that the `ffmpeg` dependency package is not present in their release or is simply a rebranded `libav` which is not directly compatible. Please [obtain the ffmpeg package directly from the FFMPEG site](https://ffmpeg.org/download.html#build-linux) to use Jellyfin on Ubuntu. - -For instructions on using the repository, please see [our wiki](https://github.com/jellyfin/jellyfin/wiki/Jellyfin-Debian-repository). - -## Building Jellyfin packages from source - -Jellyfin seeks to integrate build facilities for any desired packaging format. Instructions for the various formats can be found below. - -NOTE: When building from source, only cloning the full Git repository is supported, rather than using a `.zip`/`.tar` archive, in order to support submodules. - -### Debian/Ubuntu - -Debian build facilities are integrated into the repo at `debian/`. - -0. Install the `dotnet-sdk-2.2` package via [Microsoft's repositories](https://dotnet.microsoft.com/download/dotnet-core/2.2). -0. Run `dpkg-buildpackage -us -uc`. -0. Install the resulting `jellyfin_*.deb` file on your system. - -A huge thanks to Carlos Hernandez who created the original Debian build configuration for Emby 3.1.1. - -### Windows (64 bit) - -A pre-built windows installer will be available soon. Until then it isn't too hard to install Jellyfin from Source. - -0. Install the dotnet core SDK 2.2 from [Microsoft's Webpage](https://dotnet.microsoft.com/download/dotnet-core/2.2) and [install Git for Windows](https://gitforwindows.org/) -0. Clone Jellyfin into a directory of your choice. - ``` - git clone https://github.com/jellyfin/jellyfin.git C:\Jellyfin - ``` -0. From the Jellyfin directory you can use our Jellyfin build script. Call `Build-Jellyfin.ps1 -InstallFFMPEG` from inside the directory in a powershell window. Make sure you've set your executionpolicy to unrestricted. - - Additional flags: - * If you want to optimize for your environment you can use the `-WindowsVersion` and `-Architecture` flags to do so; the default is generic Windows x64. - * The `-InstallLocation` flag lets you select where the compiled binaries go; the default is `$Env:AppData\JellyFin-Server\` . - * The `-InstallFFMPEG` flag will automatically pull the stable ffmpeg binaries appropriate to your architecture (x86/x64 only for now) from [Zeranoe](https://ffmpeg.zeranoe.com/builds/) and place them in your Jellyfin directory. -0. (Optional) Use [NSSM](https://nssm.cc/) to configure JellyFin to run as a service -0. Jellyfin is now available in the default directory (or the directory you chose). Assuming you kept the default directory, to start it from a Powershell window, run, `&"$env:APPDATA\Jellyfin-Server\EmbyServer.exe"`. To start it from CMD, run, `%APPDATA%\Jellyfin-Server\EmbyServer.exe` From e7d18ce11fb2f394931642f448420df09c0f2049 Mon Sep 17 00:00:00 2001 From: Anthony Lavado Date: Tue, 18 Dec 2018 18:09:40 -0500 Subject: [PATCH 2/3] Change formatting slightly Removed the line break in the Feature/Issue links, --- README.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 51a6d5db2..2c5e422e0 100644 --- a/README.md +++ b/README.md @@ -39,13 +39,11 @@ Jellyfin is descended from Emby 3.5.2, ported to the .NET Core framework, and ai

-New idea or improvement? -
+ New idea or improvement? Open a Feature Request.

-Something not working right? -
+ Something not working right? Open an Issue.

From ad8483bf1696cbc249e76e8c2d913d008d251764 Mon Sep 17 00:00:00 2001 From: Anthony Lavado Date: Tue, 18 Dec 2018 18:13:10 -0500 Subject: [PATCH 3/3] Add announce chat link As per @joshuaboniface, adding a link to the announce chat. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 2c5e422e0..af73ccd51 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ Jellyfin is a free software media system that puts you in control of managing an For further details, please see [our wiki](https://github.com/jellyfin/jellyfin/wiki). -To receive the latest project updates feel free to join [our public chat on Matrix/Riot](https://matrix.to/#/#jellyfin:matrix.org), and follow us on [Social Media](https://github.com/jellyfin/jellyfin/wiki/Social-Media). +To receive the latest updates, please visit [our public chat on Matrix/Riot](https://matrix.to/#/#jellyfin:matrix.org), our [announce chat](https://matrix.to/#/#jellyfin-announce:matrix.org) for release info, and follow us on [Social Media](https://github.com/jellyfin/jellyfin/wiki/Social-Media). ## About