colin/sublime-music
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Added NixOS install instructions to the README

Browse Source
This commit is contained in:
Sumner Evans
2020-08-05 15:57:38 -06:00
parent bb07eefbc7
commit a0788aef73
2 changed files with 82 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

41
README.rst
View File

@@ -54,6 +54,47 @@ over the LAN to Chromecast devices also install ``python-bottle``.
.. |AUR Package| replace:: ``sublime-music`` package
.. _AUR Package: https://aur.archlinux.org/packages/sublime-music/
**Via NixOS**:
Sublime Music is part of the nixpkgs-unstable channel that is used by NixOS_.
To install Sublime Music on NixOS, either use the declarative or the imperative
way:
- In ``configuration.nix`` (declarative)::
environment.systemPackages = [ pkgs.sublime-music ];
- In command line (imperative)::
nix-env -iA sublime-music
To customize the extra components installed, you need to use the ``override``
function provided by Nix::
(sublime-music.override {
serverSupport = true;
chromecastSupport = true;
})
The following components are supported:
* ``chromecastSupport``: if you want support for playing on Chromecast devices
on the LAN
* ``serverSupport``: if you want to be able to serve cached files from your
computer over the LAN to Chromecast devices
* ``keyringSupport``: if you want to store your passwords in the system keyring
instead of in plain-text
* ``notifySupport``: if you want to enable notifications when a new song begins
to play
* ``networkSupport``: if you want to change the address used to access the
server depending on what network you are connected to.
See `Nix package management`_ for more information.
.. _NixOS: https://nixos.org/nixos
.. _Nix package management: https://nixos.org/nixos/manual/index.html#sec-package-management
**Via the Debian package**
Sublime Music is not currently in the Debian 'Stable' distribution, but has been

67
docs/index.rst
View File

@@ -68,6 +68,47 @@ the package with::
sudo apt install sublime-music
**Via NixOS**:
Sublime Music is part of the nixpkgs-unstable channel that is used by NixOS_.
To install Sublime Music on NixOS, either use the declarative or the imperative
way:
- In ``configuration.nix`` (declarative)::
environment.systemPackages = [ pkgs.sublime-music ];
- In command line (imperative)::
nix-env -iA sublime-music
To customize the extra components installed, you need to use the ``override``
function provided by Nix::
(sublime-music.override {
serverSupport = true;
chromecastSupport = true;
})
The following components are supported:
* ``chromecastSupport``: if you want support for playing on Chromecast devices
on the LAN
* ``serverSupport``: if you want to be able to serve cached files from your
computer over the LAN to Chromecast devices
* ``keyringSupport``: if you want to store your passwords in the system keyring
instead of in plain-text
* ``notifySupport``: if you want to enable notifications when a new song begins
to play
* ``networkSupport``: if you want to change the address used to access the
server depending on what network you are connected to.
See `Nix package management`_ for more information.
.. _NixOS: https://nixos.org/nixos
.. _Nix package management: https://nixos.org/nixos/manual/index.html#sec-package-management
**Via Flatpak**:
In the future, you will be able to install via Flathub. For now, if you want to
@@ -84,32 +125,6 @@ and run it by executing::
.. _Releases: https://gitlab.com/sublime-music/sublime-music/-/releases
**Via NixOS**:
Sublime-music is part of the nixpkgs-unstable channel that is used by NixOS_.
To install sublime-music on NixOS, either use the declarative or the imperative way:
- In ``configuration.nix`` (declarative)::
environment.systemPackages = [ pkgs.sublime-music ];
- In command line (imperative)::
nix-env -iA sublime-music
To customize the extra components installed, you need to use the ``override`` function provided by Nix::
(sublime-music.override {
serverSupport = true;
chromecastSupport = true;
})
See `Nix package management`_ for more information.
.. _NixOS: https://nixos.org/nixos
.. _Nix package management: https://nixos.org/nixos/manual/index.html#sec-package-management
**Via PyPi**::
pip install sublime-music