README.asciidoc



    1 README
    2 ======
    3 
    4 
    5 Description
    6 -----------
    7 
    8 Noteless provides a simple command line interface to note taking.
    9 
   10 What makes this different than simply using a command line text editor is there
   11 is no need to type paths or file extensions. It handles all of the file
   12 management without having to change directories. It can also perform search
   13 operations without having to write a long command.
   14 
   15 
   16 Prerequisites
   17 -------------
   18 * gcc
   19 * make
   20 
   21 
   22 Installation
   23 ------------
   24 
   25 * Clone this repository
   26 * cd noteless
   27 * make
   28 
   29 There is currently no **make install** for noteless yet, but the binary will
   30 run from anywhere. Just symlink it to **~/bin/noteless** (or just copy it
   31 there), add ~/bin to your path, and you should be good to go.
   32 
   33 Another method is to create an alias. Noteless is a single binary, so it will
   34 run from any location.
   35 
   36 
   37 Commands
   38 --------
   39 
   40 * *cat*: Outputs the specified note's contents verbatim.
   41 * *new*: Creates the specified note and opens for editing.
   42 * *edit*: Opens the specified note for editing.
   43 * *find*: Performs a case insensitive search of all notes, displaying only
   44   the lines that match along with their line numbers and files from which
   45   they came.
   46 * *ls*: Lists all notes
   47 * *help*:  Displays the help text.
   48 * *rm*: Deletes the specified note