commit 38c0a17fe1cb393b7e6011eb4a0075441718aa1b
parent 5b9201f30726d3b45c1207323afdb64331b7a7ee
Author: night0721 <[email protected]>
Date: Wed, 22 May 2024 11:10:23 +0100
update readme
Diffstat:
| M | README.md | | | 39 | +++++++++++++++++++-------------------- |
1 file changed, 19 insertions(+), 20 deletions(-)
diff --git a/README.md b/README.md
@@ -1,22 +1,37 @@
# noted
-
noted is a minimalistic command line note manager written in C.
# Preview
+# Usage
+```
+Usage: ./noted [-l] [-i] [-v] [-h]
+ ./noted [-I|-Q|-R|-S] [filename]
+noted is a minimalistic command line note manager written in C.
+Options:
+ -l Lists the notes in the directory in a tree format.
+ -i Prints the directory where the notes are stored.
+ -v Prints the version of the program.
+ -h Show the help message.
+ -I [filename] Creates a new note with the name specified in the filename.
+ -Q [filename] Searches for the note with specified name and prints its path to the stdout.
+ -R [filename] Removes the note specified in the filename.
+ -S [filename] Prints the content of the note specified in the filename.
+```
+
# Dependencies
None
# Building
-
+You will need to run these with elevated privilages.
```
$ make
# make install
```
-## Features
+# Features
- Uses EDITOR environment variable to open notes
- Respect XDG variables
- Search notes by name with interactive prompt
@@ -25,7 +40,7 @@ $ make
- Supports org, txt, markdown and html format
- Generate boilerplate for notes for different formats
-## Before you get started
+# Notes
noted will use the editor defined in the `EDITOR` environment variable to open notes. If `EDITOR` is not defined, you will need to define it in your shell configuration file.
Default file extension is `.md` and it can be changed in `config.h` file as you like. Once you change the extension, you need to recompile the program to apply the changes and the new notes will have different boilerplates. However, all commands will not work for old notes with the previous extension.
@@ -34,22 +49,6 @@ When adding note, you can add a slash to indicate a subdirectory. For example, `
Unlike pass, you don't need to use `noted init` to initialise the store, it is automatically created once you use any command. The store is either in HOME or XDG_CONFIG_HOME if it is defined.
-## Usage
-```
-Usage: ./noted [-l] [-i] [-v] [-h]
- ./noted [-I|-Q|-R|-S] [filename]
-noted is a minimalistic command line note manager written in C.
-Options:
- -l Lists the notes in the directory in a tree format.
- -i Prints the directory where the notes are stored.
- -v Prints the version of the program.
- -h Show the help message.
- -I [filename] Creates a new note with the name specified in the filename.
- -Q [filename] Searches for the note with specified name and prints its path to the stdout.
- -R [filename] Removes the note specified in the filename.
- -S [filename] Prints the content of the note specified in the filename.
-```
-
# Contributions
Contributions are welcomed, feel free to open a pull request.
