night0721/log
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

add preview, license, contributions

Browse source
This commit is contained in:
Night Kaly 2024-02-18 21:46:43 +00:00
parent 7641c0c56c
commit fa36200cb6
No known key found for this signature in database
GPG key ID: 8E829D3381CFEBBE
1 changed files with 9 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
README.md
View file

@ -2,6 +2,9 @@
noted is a minimalistic command line note manager written in C.
## Preview
![](https://r2.e-z.host/3c62bb3a-a8a9-43f6-afd6-553646f51dc4/lzwqimtg.png)
## Dependencies
- gcc
@ -10,12 +13,6 @@ noted is a minimalistic command line note manager written in C.
$ make
$ sudo make install
```
## Usage
```sh
$ ./noted
```
## Features
- Uses EDITOR environment variable to open notes
- Respect XDG variables
@ -49,3 +46,9 @@ Options:
-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.
# License
This project is licensed under the GNU Public License v3.0. See [LICENSE](https://github.com/night0721/noted/blob/master/LICENSE) for more information.