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 *   gcc-c++
   13 *   make
   14 
   15 
   16 ## Installation
   17 
   18 *   Clone this repository
   19 *   cd noteless
   20 *   make
   21 
   22 There is currently no **make install** for noteless yet, but the binary will
   23 run from anywhere. Just symlink it to **~/bin/noteless** (or just copy it
   24 there), add ~/bin to your path, and you should be good to go.
   25 
   26 
   27 ## Commands
   28 
   29 *   **cat**: Outputs the specified note's contents verbatim.
   30 *   **new**: Creates the specified note and opens for editing.
   31 *   **edit**: Opens the specified note for editing.
   32 *   **ls**: Lists all notes
   33 *   **find**: Performs a case insensitive search of all notes, displaying only
   34     the lines that match along with their line numbers and files from which
   35     they came.
   36 *   **help**:  Displays the help text.
   37 *   **rm**: Deletes the specified note