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

Update Docs

Browse source 
Updated loggingsystem.txt, instlling.txt and the README file.
This commit is contained in:
dmarakom6 2021-04-18 13:05:55 +03:00
parent 10118774f3
commit e12b79fdf5
3 changed files with 10 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
docs/github/README.md
View file

@ -3,8 +3,8 @@
A easy, simple and fast way to keep notes via your linux terminal. A easy, simple and fast way to keep notes via your linux terminal.
# What is shellnotes? # What is shellnotes?
Shellnotes is a note system for advanced linux and terminal users. It is made out of commands and scripts, and has tons of abilities. Shellnotes is a note system for advanced linux and terminal users. It is made out of a lot of other commands and scripts, and has tons of abilities, like a logging system, an auto-update feature, and much more!
Shellnotes uses your favourite text editor to save notes on-the-go. If you are the type of guy that has his terminal open 24/7, you can also save notes __directly__ via terminal! Shellnotes uses your favourite text editor to save notes on the go. If you are the type of guy that has his terminal open 24/7, you can also save notes __directly__ via terminal!
With shellnotes, you can make, find, list, edit or delete your notes from wherever you are, whenever you want. With shellnotes, you can make, find, list, edit or delete your notes from wherever you are, whenever you want.
# Why use shellnotes? # Why use shellnotes?
@ -13,13 +13,13 @@ With shellnotes, you can make, find, list, edit or delete your notes from wherev
* It can suit both dynamic and regular users, as it brings a classic TUI experience as well as some more modern abilities. * It can suit both dynamic and regular users, as it brings a classic TUI experience as well as some more modern abilities.
* It runs __exclusively__ in your terminal, its source files are stored in your home folder. * It runs __exclusively__ in your terminal, its source files are stored in your home folder.
* It's lightweight * It's lightweight
* It's [more than just a program for taking notes](#learn-everything-shellnotes-can-do). It has a ton of other interesting abilities. * It's [more than just a program for taking notes.](#learn-everything-shellnotes-can-do). It has a ton of other interesting abilities.
* It's portable and compatible with most shells. * It's portable and compatible with most shells.
* It matches all users, by creating the appropriate environment for both beginners and advanced linux users. * It matches all the users' experience, by creating the appropriate environment for both beginners and advanced users linux users.
* Even if you delete shellnotes, your notes will stay where they are. * Even if you delete shellnotes, your notes will stay where they are.
* It has a simple file organization system and [TUI](https://en.wikipedia.org/wiki/Text-based_user_interface). * It has a simple file organization system and [TUI](https://en.wikipedia.org/wiki/Text-based_user_interface).
* It's easy to install, delete, update or use. * It's easy to install, delete, update or use.
* It's mostly written in [shell](https://en.wikipedia.org/wiki/Shell_script), which is the language for Unix/Linux [CLI](https://en.wikipedia.org/wiki/Command-line_interface) in-terminal applications. * It's mostly written in [shell](https://en.wikipedia.org/wiki/Shell_script), which is the language for Unix/Linux [CLI](https://en.wikipedia.org/wiki/Command-line_interface) applications.
# How to install # How to install
After downloading the source code, navigate to the folder where it's stored, and execute the install script (`install.sh`), using the `sh` command. After downloading the source code, navigate to the folder where it's stored, and execute the install script (`install.sh`), using the `sh` command.

2
docs/installing.txt
View file

@ -26,7 +26,7 @@ About Installing:
MacOS usually uses bash as its default shell, this means that the program will work properly, but the user will have to change the default path as well as the editors. MacOS usually uses bash as its default shell, this means that the program will work properly, but the user will have to change the default path as well as the editors.
For Windows Users: For Windows Users:
The only possible way for the user to use shellnotes in a Windows PC, is to install Windows Terminal. Windows Terminal is a multi-tabbed command-line front-end that Microsoft has developed for Windows 10, as a replacement for Windows Console. It can run any command-line app, including all Windows terminal emulators, in a separate tab. It is preconfigured to run Command Prompt, PowerShell, WSL, SSH, and Azure Cloud Shell Connector. If the user changes the default path and text editors, the program might work. The only possible way for the user to use shellnotes in a Windows PC, is to install Windows Terminal. Windows Terminal is Windows Terminal is a multi-tabbed command-line front-end that Microsoft has developed for Windows 10, as a replacement for Windows Console. It can run any command-line app, including all Windows terminal emulators, in a separate tab. It is preconfigured to run Command Prompt, PowerShell, WSL, SSH, and Azure Cloud Shell Connector. If the user changes the default path and text editors, the program might work.
For other distro Users: For other distro Users:
Installation and use is the same. (Debian excluded. The dash shell is not supported) Installation and use is the same. (Debian excluded. The dash shell is not supported)

4
docs/system/loggingsystem.txt
View file

@ -37,10 +37,12 @@ Opening the logfiles:
Logfiles and content: Logfiles and content:
~/.shellnotes/logs/disfailed.txt - failed attempt to disable shellnotes. ~/.shellnotes/logs/disfailed.txt - failed attempt to disable shellnotes.
~/.shellnotes/logs/enfailed.txt - failed attempt to enable shellnotes. ~/.shellnotes/logs/enfailed.txt - failed attempt to enable shellnotes.
~/.shellnotes/logs/ifailed.txt - failed attempt to install shellnotes (might fail to log). ~/.shellnotes/logs/ifailed.txt - failed attempt to install shellnotes.
~/.shellnotes/logs/uninfailed.txt - failed attempt to uninstall shellnotes. ~/.shellnotes/logs/uninfailed.txt - failed attempt to uninstall shellnotes.
~/.shellnotes/logs/ufailed.txt - failed attempt to update shellnotes. ~/.shellnotes/logs/ufailed.txt - failed attempt to update shellnotes.
To close a file after you chose to open it, press "Q". Shellnotes uses the less command to view
its logfiles.
Clearing all the logfiles: Clearing all the logfiles:
-There is a hidden function called "clearlogs" in the /util directory. When run, it clears all the content from all logfiles. This can be useful for saving space on the disk. It can be run by writing "clearlogs" in the terminal. -There is a hidden function called "clearlogs" in the /util directory. When run, it clears all the content from all logfiles. This can be useful for saving space on the disk. It can be run by writing "clearlogs" in the terminal.