luisgulo/shellnotes
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Delete old README

Browse source
This commit is contained in:
dmarakom6 2021-04-03 09:52:52 +03:00
parent ba2a8ddf18
commit 9bd9e74e3b
1 changed files with 0 additions and 60 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

60
help
View file

@ -1,60 +0,0 @@
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.
-findnote: Find a specific note in your Notes folder.
-findmisplacednote: Find a misplaced note in your system.
-renamenote: Rename a note in your Notes folder.
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, or add '-all' to delete all notes.
-findnote: Type the name of the note you want to locate.
-findmisplacednote: Type the name of the misplaced note and check the possible locations
-renamenote: Enter the name of the note, then the new note name and press enter.
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!
-If you want to check if shellnotes is working proprely, try typing "shellnotes" in the terminal!
-If you want to delete all your notes inside your folder, type "delnote -all".
-If quickread shows nothing, your Note must be blank.
Don't seem to find your note? Try these steps:
1. Type findnote in your terminal and try to locate the file in your Notes folder.
2. Try using findmisplacednote to check if your note is in the wrong location.
3. Try listing your notes with listnotes and check if your note is there, maybe you renamed it.
4. Try navigating into your Notes folder, then showing hidden files. Maybe the note is hidden.
Changing default editors:
Changing editors is a feature enabled in shellnotes <1.0. In case the user wants to change the
default editors, he must change the NOTES_EDITOR and QUICK_NOTES_EDITOR values from the code. These are two variables that the rest of the code uses to check the default editor for commands like newnote and quicknote. This means that if you change the name of the program the variables are going to search for, the code will use your prefered editor. In case the name is incorrect, problems may occur.
Default editors:
for newnote: gedit (ubuntu default)
for quicknote: nano (in-terminal experience)
Suggested editors other than default:
for newnote: Sublime text, Atom
for quicknote: Vim
Changing default Notes Folder:
Changing default folder is a feature enabled in shellnotes <2.5. In case the user wants to change the default folder to store/write/list/rename/read/delete his notes, he must change the DEFAULT_PATH value from the code (found in line 9). This is a variable that the rest of the code uses to check the default folder for all the commands to make change in the right directory. This means that if you change the name of the path the variable is going to search for, the code will use your prefered folder. In case the path is incorrect, problems may occur.