shellnotes/help
dmarakom6 75732b65ba Updated shellnotes to version 1.0
Shellnotes has just become even more dynamic and smart!
Additions:
	-Added quickread: Read notes from terminal
	-Added listnotes: List your notes
	-Added delnote: Delete a note from your folder
	-Added Help Page (help.txt)
	-Quicknote will now ask you to read a note if it already exists
	-Readnote will now ask you to write a new note if it doesn't exist
	-Shellnotes is now able to make a Notes folder if the user hasn't made one
	-Shellnotes now knows who you are and where you are! The program copies the user's name and directory to help him take notes faster and safer
	-You can now use different text editors for taking your notes

Have fun taking notes!
2020-12-07 13:55:20 +02:00

33 lines
1.7 KiB
Text

SHELLNOTES HELP PAGE
--------------------
Commands:
-newnote: Write a new note using gedit.
-quicknote: Write a note directly from terminal.
-readnote: Read a note from your text-editor.
-quickread: Read a note directly from terminal.
-listnotes: View a full list of notes from your notes folder.
-delnote: Delete a note from your notes folder.
shellnotes: information about shellnotes.
Usage:
-newnote: Take your notes in the text editor and name the file.
-quicknote: Write the name of the file and take your notes in the terminal, press Ctrl+X, then Y to save. Rename the file if you'd like, then hit Enter key to save.
-readnote: Type the name of the file and start reading your notes from your text-editor.
quickread: Type the name of the file and start reading your notes from your terminal.
delnote: Write the name of the note you want to delete.
shellnotes Parameters:
-v: version
-r: github repository
-h or --help: help
Tips:
-If a note that you want to read using readnote doesn't exist, you will be asked to create one using newnote.
-If a note that you want to write with quicknote already exists, you will be asked to read it using readnote.
-If you type a blank note name in readnote, you will automatically create a new note. You can do this if you want to take a note but you are using readnote.
-Deleting notes using delnote won't send the files to Trash. They will be deleted forever, so don't store other files in your Notes folder.
-Even if you don't have a Notes folder, shellnotes will make one for you.
-No matter in which directory you are, shellnotes will work from everywhere - and when your done taking notes, you will get back on your previous working directory!