summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAaron Ball <nullspoon@oper.io>2017-01-03 08:27:50 -0700
committerAaron Ball <nullspoon@oper.io>2017-01-03 08:27:50 -0700
commitb525ca2496a1cb4f6803d652863fb2cf019d9457 (patch)
tree7352d9b00f2b61b95951bfec1c5bb5d005dff4fb
parent40fb2056cf51d140378b627637271e7b57229d52 (diff)
downloadnoteless-b525ca2496a1cb4f6803d652863fb2cf019d9457.tar.gz
noteless-b525ca2496a1cb4f6803d652863fb2cf019d9457.tar.xz
Converted README file from markdown to asciidoc
-rw-r--r--README.asciidoc49
-rw-r--r--README.md37
2 files changed, 49 insertions, 37 deletions
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
-

Generated by cgit