nanorc/Readme.rst

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

    git clone git@github.com:scopatz/nanorc.git ~/.nano

*Note - if you have any issues, alternatively use::

    git clone https://github.com/scopatz/nanorc.git ~/.nano


Once there you should add the languages you want to your
nano configuration file ``~/.nanorc``.  For example::

    ## C/C++
    include "~/.nano/c.nanorc"

You can also append the contents of ``~/.nano/nanorc`` into your
``~/.nanorc`` to include all languages::

    cat ~/.nano/nanorc >> ~/.nanorc

Finally, you can run an automatic installer using the following code::

    $ curl https://raw.githubusercontent.com/scopatz/nanorc/master/install.sh | sh

or alternatively::

    $ wget https://raw.githubusercontent.com/scopatz/nanorc/master/install.sh -O- | sh

*Note -
    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.
First nanorc commit. 2010-07-29 00:15:43 +02:00			`***************************************`
			`Improved Nano Syntax Highlighting Files`
			`***************************************`

Adds instructions and formatting fixes to Readme.rst 2013-12-20 07:05:51 +01:00			This repository holds ``{lang}.nanorc`` files that have improved
First nanorc commit. 2010-07-29 00:15:43 +02:00			`definitions of syntax highlighting for various languages.`
			These should be placed inside of the ``~/.nano/`` directory.
Adds instructions and formatting fixes to Readme.rst 2013-12-20 07:05:51 +01:00			`Alternatively::`

			`git clone git@github.com:scopatz/nanorc.git ~/.nano`
Add -l\|--lite option to install which includes new syntax files with lower precedence 2017-02-21 13:25:43 +01:00
add alternate cloning method Upon first try I recived a permission denied msg when attempting to clone the repository. For ease of use when future users attempt to use this repository, I've added an alternative method as a backup. 2014-06-20 20:23:58 +02:00			`*Note - if you have any issues, alternatively use::`

			`git clone https://github.com/scopatz/nanorc.git ~/.nano`

First nanorc commit. 2010-07-29 00:15:43 +02:00
			`Once there you should add the languages you want to your`
Includes instructions for import.nanorc in Readme.rst 2013-12-20 06:58:35 +01:00			nano configuration file ``~/.nanorc``. For example::
First nanorc commit. 2010-07-29 00:15:43 +02:00
			`## C/C++`
			`include "~/.nano/c.nanorc"`

Adds instructions and formatting fixes to Readme.rst 2013-12-20 07:05:51 +01:00			You can also append the contents of ``~/.nano/nanorc`` into your
			``~/.nanorc`` to include all languages::

			`cat ~/.nano/nanorc >> ~/.nanorc`
Add -l\|--lite option to install which includes new syntax files with lower precedence 2017-02-21 13:25:43 +01:00
Updated readme with installer instructions 2015-12-15 04:05:43 +01:00			`Finally, you can run an automatic installer using the following code::`

have wget be an alternative to curl for running the installer 2016-10-14 00:46:08 +02:00			`$ curl https://raw.githubusercontent.com/scopatz/nanorc/master/install.sh \| sh`

			`or alternatively::`

use wget instead of curl for automatic installer reasons to use wget includes: wget is more ubiquitously available than curl. (my particular problem: curl isn't shipped in Debian by default) wget's ability to recover from a prematurely broken transfer and continue downloading has no counterpart in curl. reasons for using curl: ... in theory, curl could be faster by enabling --compressed , which would make the github servers gzip-compress the transfer (curl: "Accept-Encoding: deflate, gzip" github: "Content-Encoding: gzip", which as of speaking would save 158 bytes, extra header not accounted for) but since we're not using --compressed anyway, and that the script is really small (355 bytes), it's a moot point. i think we should use wget. 2016-10-14 00:23:41 +02:00			`$ wget https://raw.githubusercontent.com/scopatz/nanorc/master/install.sh -O- \| sh`
Add -l\|--lite option to install which includes new syntax files with lower precedence 2017-02-21 13:25:43 +01:00
			`*Note -`
			`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.`