update readme

This commit is contained in:
Night Kaly 2024-05-22 11:10:23 +01:00
parent 5b9201f307
commit 38c0a17fe1
Signed by: night0721
GPG key ID: 957D67B8DB7A119B

View file

@ -1,40 +1,10 @@
# noted # noted
noted is a minimalistic command line note manager written in C. noted is a minimalistic command line note manager written in C.
# Preview # Preview
![](https://r2.e-z.host/3c62bb3a-a8a9-43f6-afd6-553646f51dc4/lzwqimtg.png) ![](https://r2.e-z.host/3c62bb3a-a8a9-43f6-afd6-553646f51dc4/lzwqimtg.png)
# Dependencies # Usage
None
# Building
```
$ 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
## Before you get started
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.
When adding note, you can add a slash to indicate a subdirectory. For example, `noted -I maths/ch1` will create a note called `ch1` in `maths` folder. **Note**: You can't create a note in a non-existing folder. You need to create the folder first manually.
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] Usage: ./noted [-l] [-i] [-v] [-h]
./noted [-I|-Q|-R|-S] [filename] ./noted [-I|-Q|-R|-S] [filename]
@ -50,6 +20,35 @@ Options:
-S [filename] Prints the content of 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
- 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.
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.
When adding note, you can add a slash to indicate a subdirectory. For example, `noted -I maths/ch1` will create a note called `ch1` in `maths` folder. **Note**: You can't create a note in a non-existing folder. You need to create the folder first manually.
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.
# Contributions # Contributions
Contributions are welcomed, feel free to open a pull request. Contributions are welcomed, feel free to open a pull request.