shellnotes/README.md

59 lines
1.7 KiB
Markdown
Raw Normal View History

2020-12-11 10:27:59 +01:00
# shellnotes
A simple and easy way to keep notes via your linux terminal.
# Basic Commands:
## newnote:
2021-01-26 20:38:16 +01:00
Write a new note using gedit.
2020-12-11 10:27:59 +01:00
## quicknote:
Write a note directly from terminal.
## readnote:
Read a note from your text-editor.
## quickread:
Read a note directly from terminal.
## listnotes:
2021-01-26 20:38:16 +01:00
View a full list of notes from your notes folder.
2020-12-11 10:27:59 +01:00
## delnote:
2021-01-26 20:38:16 +01:00
Delete a note from your notes folder.
## shellnotes(-v,-r,-h or --help):
2021-02-05 20:53:02 +01:00
Information about shellnotes.
2021-01-01 21:05:16 +01:00
## findnote:
2021-02-05 20:53:02 +01:00
Find a specific note in your Notes folder.
## findmisplacednote:
Find a misplaced note in your system.
2021-01-01 21:05:16 +01:00
## renamenote:
2021-02-05 20:53:02 +01:00
Rename a note.
2021-01-01 21:05:16 +01:00
2020-12-11 10:27:59 +01:00
# How to download
-You can either download or clone this repository.
# How to install
## step 1:
-Place the file "shellnotes.sh" and "help" into your home folder.
## step 2:
-Rename the file and add a dot before its name. It should look like this: ".shellnotes.sh" and ".help" in the home folder.
## step 3:
-Open the terminal and type:
`chmod +x ~/.shellnotes.sh`
## step 4:
2021-02-05 20:53:02 +01:00
-Open any text editor you want. Select "Open file" from its menu (Usually top left) and navigate to home. Then, press `Ctrl + H` in order to show all the hidden files and folders
2021-01-01 21:05:16 +01:00
in the home directory. Find a file called `.bashrc` and open it.
2020-12-11 10:27:59 +01:00
## step 5:
2021-01-26 20:38:16 +01:00
-Go to the last line of the file you opened in step 4, and write: `source ~/.shellnotes.sh` in order to be able to use shellnotes every time you launch your terminal.
2020-12-11 10:27:59 +01:00
# Warnings!
2021-01-26 20:38:16 +01:00
*THIS SYSTEM IS MADE FOR BASH SHELL* Change your shell if necessary.
2021-01-01 21:05:16 +01:00
2021-01-26 20:38:16 +01:00
*DON'T CHANGE THE SCRIPT* Only in case you don't have the default editors who are gedit and nano. In that case, you can either change them (see Help Page), or install the default ones.