ShellNotes v1.0

🎉 ShellNotes v1.0 – Simple Terminal Session Logging Made Powerful

📦 What's Included

• 📁 All project files packaged in a .zip archive
• 🛠️ install.sh script to install ShellNotes system-wide
• 📃 requirements.txt for Python dependencies

---

🚀 About ShellNotes

ShellNotes is a lightweight, terminal-first logging tool built for developers, sysadmins, students, and command-line power users.

✨ Key Features

• 🧠 Create, read, and manage logs in your terminal
• 📂 Organized file-based logs with simple navigation
• 🔒 Secure, local-only storage of notes
• 🖥️ Opens in your default terminal emulator
• 🧩 Easy to install and run with just one command

---

🛠️ Installation Instructions

1. 📥 Download & Extract

Unzip the downloaded archive:

unzip shellnotes-v1.0.zip
cd shellnotes-release

2.🔧 Install the Program

Run the installer script (requires sudo):

sudo ./install.sh

This script will:

• Install Python 3 and pip3 if not present

• Install required Python packages from requirements.txt

• Copy ShellNotes to /usr/local/bin/shellnotes-launcher

• Create a symbolic link at /usr/local/bin/shellnotes

• Ensure permissions and create a launcher script that opens ShellNotes in a new terminal instance

3. 🚀 Launch the App

You can now launch ShellNotes from any terminal window:

shellnotes

📋 Requirements

Make sure you have the following installed:

• ✅ Python 3.7 or newer

• ✅ pip3 (Python package manager)

• ✅ One of the following terminal emulators:

  • gnome-terminal

  • konsole

  • xfce4-terminal

  • xterm

🔒 Permissions

The installer requires root privileges to:

• Place the executable in /usr/local/bin

• Create symlinks and set file permissions

• Suppress unnecessary output and warnings from pip

📌 Notes

• The launcher automatically finds your available terminal emulator and opens ShellNotes in a clean session.

• Any old installations or symlinks will be cleaned up automatically before reinstalling.

• Non-critical warnings (e.g., pip root user warning or metadata skips) are suppressed for a clean install experience.

❤️ Contributing

Want to contribute? Fork the repo, open issues, or submit pull requests! Feedback and ideas are always welcome.

📬 Contact

If you need support or have suggestions, open an issue on GitHub or contact the maintainer directly.

Thank you for using ShellNotes! 🐚📝