README.md



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