commit ed4684d8dce58d9968074a0ce51620c4b4b7f96d
parent 9fe928b7539ccac8662a25daa2c3548020143bda
Author: night0721 <[email protected]>
Date: Wed, 22 May 2024 11:23:51 +0100
update readme
Diffstat:
1 file changed, 10 insertions(+), 10 deletions(-)
diff --git a/README.md b/README.md
@@ -5,7 +5,7 @@ noted is a minimalistic command line note manager written in C.
![](https://r2.e-z.host/3c62bb3a-a8a9-43f6-afd6-553646f51dc4/lzwqimtg.png)
# Usage
-```
+```sh
Usage: ./noted [-l] [-i] [-v] [-h]
./noted [-I|-Q|-R|-S] [filename]
noted is a minimalistic command line note manager written in C.
@@ -20,6 +20,15 @@ Options:
-S [filename] Prints the content of the note specified in the filename.
```
+# Features
+- Uses EDITOR environment variable to open notes
+- Respect XDG variables
+- Search notes by name with interactive prompt
+- Add, remove, and list notes
+- Customizable
+- Supports org, txt, markdown and html format
+- Generate boilerplate for notes for different formats
+
# Dependencies
None
@@ -31,15 +40,6 @@ $ make
# make install
```
-# Features
-- Uses EDITOR environment variable to open notes
-- Respect XDG variables
-- Search notes by name with interactive prompt
-- Add, remove, and list notes
-- Customizable
-- Supports org, txt, markdown and html format
-- Generate boilerplate for notes for different formats
-
# 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.