From 51b5d112748ea61cd8ff94b97f760887ca833bdd Mon Sep 17 00:00:00 2001 From: sledgeh Date: Sun, 23 Apr 2017 23:16:19 +0300 Subject: [PATCH] Update README. Better install manual. --- Readme.rst | 39 ++++++++++++++++++++++++++++++++++++--- 1 file changed, 36 insertions(+), 3 deletions(-) diff --git a/Readme.rst b/Readme.rst index 3582010..4789179 100644 --- a/Readme.rst +++ b/Readme.rst @@ -4,15 +4,28 @@ Improved Nano Syntax Highlighting Files This repository holds ``{lang}.nanorc`` files that have improved definitions of syntax highlighting for various languages. -These should be placed inside of the ``~/.nano/`` directory. -Alternatively:: + + +1. Copy files +~~~~~~ + +These should be placed inside of the ``~/.nano/`` directory. +Or for system-wide installation ``/usr/share/nano-syntax-highlighting/``. +In other words:: git clone git@github.com:scopatz/nanorc.git ~/.nano -*Note - if you have any issues, alternatively use:: +*Note - if you have any issues (ssh was not properly configured), alternatively use:: git clone https://github.com/scopatz/nanorc.git ~/.nano + +*System wide will look like so*:: + sudo git clone https://github.com/scopatz/nanorc.git /usr/share/nano-syntax-highlighting/ + + +2. Configure ``nano`` +~~~~~~~~~ Once there you should add the languages you want to your nano configuration file ``~/.nanorc``. For example:: @@ -24,7 +37,18 @@ You can also append the contents of ``~/.nano/nanorc`` into your ``~/.nanorc`` to include all languages:: cat ~/.nano/nanorc >> ~/.nanorc + +Or to be less verbose, append content of the folder in one line with wildcard:: + ## For all users + $ echo "include $install_path/*.nanorc" >> /etc/nanorc + ## For current user + $ echo "include $install_path/*.nanorc" >> ~/.nanorc + +where ``$install_path`` is ``/usr/share/nano-syntax-highlighting`` or ``~/.nano/`` or ... + +1a. Automatic installer +~~~~~~~~~~~~~~~~~~~~~~ Finally, you can run an automatic installer using the following code:: $ curl https://raw.githubusercontent.com/scopatz/nanorc/master/install.sh | sh @@ -37,3 +61,12 @@ or alternatively:: some syntax definitions which exist in Nano upstream may be preferable to the ones provided by this package. The install.sh script may be run with ``-l`` or ``--lite`` to insert the included syntax definitions from this package with lower precedence than the ones provided by the standard package. + + +1b. Distributive specific installation via package managers +~~~~~~~~~~ +On **Arch Linux** and other *pacman/aur* based systems it is possible to:: + + $ yaourt nano-syntax-highlight + +Then you need to mannually add ``.nanorc``-s to user's ``~/.nanorc`` or system ``/etc/nanorc``. See **$2**