Files

glitchySid d4e8dbc6b3 docs: restructure documentation into organized files

Split the 630-line README.md into focused, well-organized documentation:

- README.md: Concise overview with quick start and links
- docs/INSTALLATION.md: Installation instructions and setup
- docs/CONFIGURATION.md: Configuration options and custom categories
- docs/USAGE.md: Command-line options and usage examples
- docs/HOW_IT_WORKS.md: Architecture and internal processes
- docs/TROUBLESHOOTING.md: Common issues and solutions
- docs/DEVELOPMENT.md: Project structure and development guide
- docs/CONTRIBUTING.md: Contribution guidelines and standards

Benefits:
- Main README is now clean and welcoming (~150 lines vs 630)
- Each doc has a clear, focused purpose
- Better navigation with cross-linking between docs
- Follows GitHub best practices with docs/ directory
- Easier to maintain and update specific sections

2026-01-02 00:55:29 +05:30

3.1 KiB

Raw Blame History

Installation Guide

This guide covers different ways to install and set up NoEntropy on your system.

Prerequisites

Before installing NoEntropy, ensure you have:

Rust 2024 Edition or later (if building from source)
Google Gemini API Key - Get one at https://ai.google.dev/
A folder full of unorganized files to clean up!

Option 1: Download Pre-built Binary

The easiest way to get started is to download a pre-built binary for your operating system.

Download Binary

Visit the releases page and download the binary for your operating system (Windows, Linux, or macOS):
```
https://github.com/glitchySid/noentropy/releases
```
Give Permission (Linux/macOS only)

Make the binary executable:
```
chmod +x noentropy
```
Run NoEntropy
```
./noentropy
```

Option 2: Build from Source

If you prefer to build from source or want the latest development version:

Clone the Repository

git clone https://github.com/glitchySid/noentropy.git
cd noentropy

Build the Application
```
cargo build --release
```
Run the Application
```
./target/release/noentropy
```

First-Run Setup

On first run, NoEntropy will guide you through an interactive setup process:

Interactive Setup

NoEntropy provides an interactive setup if configuration is missing:

Missing API key? → You'll be prompted to enter it
Missing download folder? → You'll be prompted to specify it (with default suggestion)
Both missing? → You'll be guided through complete setup

Configuration is automatically saved to ~/.config/noentropy/config.toml after interactive setup.

Manual Configuration

Alternatively, you can manually create the configuration file:

cp config.example.toml ~/.config/noentropy/config.toml
nano ~/.config/noentropy/config.toml

See the Configuration Guide for detailed configuration options.

Getting Your Gemini API Key

Visit Google AI Studio
Sign in with your Google account
Create a new API key
Copy the key to your configuration file or enter it during interactive setup

Verification

To verify your installation works correctly:

Run NoEntropy with the --dry-run flag:
```
./noentropy --dry-run
```
You should see NoEntropy scan your downloads folder and display an organization plan without moving any files.

Next Steps

Configure NoEntropy - Learn about configuration options
Usage Guide - Learn how to use NoEntropy effectively
How It Works - Understand the organization process

Troubleshooting

If you encounter issues during installation, check the Troubleshooting Guide.

Common installation issues:

Rust not installed: Install Rust from rustup.rs
Build errors: Ensure you have the latest Rust toolchain: rustup update
Permission denied: Make sure the binary has execute permissions (Linux/macOS)

Back to Main README

3.1 KiB Raw Blame History