diff --git a/docs/github/README.md b/docs/github/README.md index c56e318..003a8a4 100644 --- a/docs/github/README.md +++ b/docs/github/README.md @@ -3,8 +3,8 @@ A easy, simple and fast way to keep notes via your linux terminal. # 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 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 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! With shellnotes, you can make, find, list, edit or delete your notes from wherever you are, whenever you want. # 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 runs __exclusively__ in your terminal, its source files are stored in your home folder. * 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 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. * 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 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 After downloading the source code, navigate to the folder where it's stored, and execute the install script (`install.sh`), using the `sh` command. @@ -120,4 +120,4 @@ Want even more information? Feel free to see the whole [shellnotes documentation *WARNING*: The default shell for shellnotes is bash. However, shellnotes will find your shell if it's different and continue installing according to it. If your shell is not supported though, the installation will fail. -*WARNING*: install.sh must be run from the folder where it was downloaded WITH the other files from the repo. Otherwise, installation will fail. (see [installation documentation](https://github.com/dmarakom6/shellnotes/blob/master/docs/installing.txt) for more). +*WARNING*: install.sh must be run from the folder where it was downloaded WITH the other files from the repo. Otherwise, installation will fail. (see [installation documentation](https://github.com/dmarakom6/shellnotes/blob/master/docs/installing.txt) for more). \ No newline at end of file diff --git a/docs/installing.txt b/docs/installing.txt index 3807e69..72b35f7 100644 --- a/docs/installing.txt +++ b/docs/installing.txt @@ -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. 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: Installation and use is the same. (Debian excluded. The dash shell is not supported) diff --git a/docs/system/loggingsystem.txt b/docs/system/loggingsystem.txt index d01a5d5..9ae6883 100644 --- a/docs/system/loggingsystem.txt +++ b/docs/system/loggingsystem.txt @@ -37,10 +37,12 @@ Opening the logfiles: Logfiles and content: ~/.shellnotes/logs/disfailed.txt - failed attempt to disable 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/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: -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. \ No newline at end of file