README
======


Description
-----------

Noteless provides a simple command line interface to note taking.

What makes this different than simply using a command line text editor is there
is no need to type paths or file extensions. It handles all of the file
management without having to change directories. It can also perform search
operations without having to write a long command.


Prerequisites
-------------
* gcc
* make


Installation
------------

* Clone this repository
* cd noteless
* make

There is currently no **make install** for noteless yet, but the binary will
run from anywhere. Just symlink it to **~/bin/noteless** (or just copy it
there), add ~/bin to your path, and you should be good to go.

Another method is to create an alias. Noteless is a single binary, so it will
run from any location.


Commands
--------

* *cat*: Outputs the specified note's contents verbatim.
* *new*: Creates the specified note and opens for editing.
* *edit*: Opens the specified note for editing.
* *find*: Performs a case insensitive search of all notes, displaying only
  the lines that match along with their line numbers and files from which
  they came.
* *ls*: Lists all notes
* *help*:  Displays the help text.
* *rm*: Deletes the specified note