Home

SuperNano

SuperNano is a console-based text editor designed to simplify file and directory management directly from the command line. Using win-curses, this application offers an interactive and functional user interface in a text-based environment. Below, you will find complete documentation regarding the features, setup, and usage guide for SuperNano.

Table of Contents

1. Main Features
2. Installation
3. Usage Guide
   • User Interface
   • Commands and Shortcuts
4. Development and Contribution
5. Troubleshooting
6. Demo
7. License

Main Features

• Interactive User Interface: Utilizes win-curses to provide a responsive and easy-to-use text-based interface.
• File Management: Manage files and directories with the ability to open, save, and delete files.
• Undo/Redo: Offers undo and redo features to manage text changes.
• File Search: Search for files and directories within the selected folder.
• Customization: Supports customizable display and functionality based on the user's needs.

Installation

Prerequisites

• Python 3.6 or newer
• Latest version of Pip

Installation Steps

1. Clone the Repository

   git clone https://github.com/LcfherShell/SuperNano.git
   cd supernano

2. Install Dependencies

   pip install -r requirements.txt

3. Run the Application

   python supernano.py <path-to-directory-or-file>

Usage Guide

User Interface

The application has several main elements:

• File Menu: Displays a list of files and directories in the current location.
• Search Box: Allows users to search for files by name.
• Text Block: The main area for displaying and editing the content of files.
• Current Directory Box: Shows the current directory.
• Footer: Provides information on available keyboard shortcuts.

Commands and Shortcuts

• Ctrl + S: Save the currently opened file.
• Ctrl + D: Delete the currently selected file.
• Ctrl + Z: Undo the last change.
• Enter: Select a file or directory from the menu.
• Backspace: Return to the previous directory.

Development and Contribution

If you're interested in contributing to the development of SuperNano, please follow these steps:

1. Fork the Repository: Create a copy of the repository for your personal development.
2. Create a New Branch: Create a new branch for the feature or fix you propose.
3. Make Changes: Implement the desired features or fixes.
4. Push and Pull Request: Submit a pull request for review.

Troubleshooting

If you encounter issues with SuperNano, consider the following steps:

• Check the Logs: Look at the log file to see if any errors are detected.
• Verify Path and Connections: Ensure the path being used is valid and accessible.
• Check the Documentation: Visit the wiki page for guidance and solutions to common problems.

Demo

Download Video This video demonstrates SuperNano's user interface, including file navigation, text editing, as well as the undo/redo feature. Make sure you watch to understand the flow of using this app!

License

SuperNano is licensed under the MIT License. See the LICENSE file for more details.

---