Skip to content

README.md

Latest commit

 

History

History
72 lines (50 loc) · 2.07 KB

README.md

File metadata and controls

72 lines (50 loc) · 2.07 KB

CleanType

Build Status

A modern, efficient text cleaning tool built with Tauri and React. CleanType helps you clean and format text with just a few clicks.

Features

  • 🧹 Quick text cleaning and formatting
  • 🚀 Lightning-fast performance with Rust backend
  • 💻 Cross-platform support (Windows)
  • 🎨 Modern, intuitive user interface
  • 🔒 Privacy-focused: all processing happens locally

Installation

Download the latest installer from our releases page.

Note: When running the installer, you may see a Windows SmartScreen warning. This occurs because the application is new and hasn't built up enough reputation yet. You can safely proceed by clicking "More info" and then "Run anyway".

System Requirements

  • Windows 10 or later
  • 64-bit processor
  • 4GB RAM recommended
  • 100MB free disk space

Development Setup

  1. Install prerequisites:

  2. Clone the repository:

    git clone https://github.com/StarKnightt/CleanType.git
cd cleantype

  3. Install dependencies:

    npm install

  4. Run in development mode:

    npm run tauri dev

  5. Build for production:

    npm run tauri build

Contributing

Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/AmazingFeature)
  3. Commit your changes (git commit -m 'Add some AmazingFeature')
  4. Push to the branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

This project is licensed under the MIT License - see the LICENSE file for details.

Support

If you encounter any issues or have questions, please open an issue on GitHub.