From b525ca2496a1cb4f6803d652863fb2cf019d9457 Mon Sep 17 00:00:00 2001 From: Aaron Ball Date: Tue, 3 Jan 2017 08:27:50 -0700 Subject: Converted README file from markdown to asciidoc --- README.asciidoc | 49 +++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 37 ------------------------------------- 2 files changed, 49 insertions(+), 37 deletions(-) create mode 100644 README.asciidoc delete mode 100644 README.md diff --git a/README.asciidoc b/README.asciidoc new file mode 100644 index 0000000..741ff98 --- /dev/null +++ b/README.asciidoc @@ -0,0 +1,49 @@ +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 + diff --git a/README.md b/README.md deleted file mode 100644 index 3f288a7..0000000 --- a/README.md +++ /dev/null @@ -1,37 +0,0 @@ -## 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. - - -## 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 - -- cgit v1.2.3