commit ef11c024b9187f3b0317c5be304d8a62e2a5ed41
parent 65c1dfe1678ba53f2a55e18d508b19a4348d7291
Author: lostd <lostd@2f30.org>
Date: Tue, 21 Oct 2014 20:42:01 +0300
Use double spacing on sentence start, smaller text width, style
Diffstat:
| M | README | | | 37 | ++++++++++++++++++++----------------- |
1 file changed, 20 insertions(+), 17 deletions(-)
diff --git a/README b/README
@@ -7,20 +7,22 @@
-- by lostd and sin
=======================================================
+
What is it?
===========
noice is a small ncurses-based file manager.
-It was first developed to be used with a tv remote control for a media center
-solution.
+It was first developed to be used with a tv remote control for a media
+center solution.
+
Getting started
===============
-Get the latest version from the git-repository; build and install it.
-Run noice in a directory to display its content in the form of a list, where
-each line is a file or directory. The currently selected item will be preceded
-with a " > " by default.
+Get the latest version from the git-repository; build and install it. Run
+noice in a directory to display its content in the form of a list, where
+each line is a file or directory. The currently selected item will be
+preceded with a " > " by default.
Navigation
----------
@@ -44,25 +46,26 @@ File opening
------------
Depending on the filetype, noice will open the selected file with the
-application specified in `config.h` at compilation time. The associations
-are specified by regexes, so you might experience issues when trying to open a file
-that does not match those regexes.
+application specified in `config.h` at compilation time. The associations
+are specified by regexes, so you might experience issues when trying to
+open a file that does not match those regexes.
-The default program is less(1). For text files, you can use the 'v'
-command in less(1) to open the file in your $EDITOR.
+The default program is `less(1)`. For text files, you can use the 'v'
+command in `less(1)` to open the file in your $EDITOR.
Filters
-------
-Filters narrow down the view. This effectively allows you to easily search/jump
-to a particular file or directory. If you want to reset the filter then you can
-just use the match-any regex (i.e. .*). You can think of noice being in search
-mode all the time.
+Filters narrow down the view. This effectively allows you to easily
+search/jump to a particular file or directory. If you want to reset the
+filter then you can just use the match-any regex (i.e. '.'). You can
+think of noice being in search mode all the time.
Filters do not stack or nest. They are applied afresh every time.
+
Contact
=======
-You can reach us through the freenode IRC network at #2f30.
-If you have any patches, ideas or feedback feel free to join.
+You can reach us through the freenode IRC network at #2f30. If you have
+any patches, ideas or feedback feel free to join.
