q3aql/nanorc
q3aql/nanorc
1
0
Fork 0
mirror of https://github.com/scopatz/nanorc synced 2024-11-23 19:00:27 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #147 from sledgeh/master

Browse Source 
Update README. Better install manual.
This commit is contained in:
Anthony Scopatz 2017-04-24 16:04:04 -04:00 committed by GitHub
commit b394ee16e1
1 changed files with 36 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
Readme.rst
View File

@ -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**