Skip to content

Latest commit

 

History

History
55 lines (44 loc) · 1.73 KB

README.md

File metadata and controls

55 lines (44 loc) · 1.73 KB

Quik Text Editor

Overview

Quik is a terminal-based text editor developed in Rust, designed to provide a minimal yet functional editing experience. Quik implements basic features expected from a text editor, along with enhancements like syntax highlighting and a search functionality.

Table of Contents

Features

  • Minimal Interface: A clean and straightforward interface for efficient text editing.
  • Search Functionality: Allows users to search for specific text within their documents.
  • Cross-Platform: Built using Rust, Quik runs on any platform that supports Rust.

Getting Started

To get started with Quik, you'll need to have Rust installed on your machine. You can install Rust using rustup.

Prerequisites

  • Rust
  • Cargo (comes with Rust installation)

Installation

  1. Clone the repository:

    git clone https://github.com/pavanmanishd/quik.git
cd quik

  2. Build the project:

    cargo build --release

  3. Run the editor:

    ./target/release/quik

Usage

Once you have Quik running, you can:

  • Open a file by passing the filename as an argument:

    ./target/release/quik myfile.txt

  • Navigation: Use the arrow keys to move around and start editing your text.

  • Save: Press Ctrl + S to save your current file.

  • Find: Press Ctrl + F to search within the document and use the arrow keys to navigate through search results.

  • Quit: Press Ctrl + Q to quit the editor.

License

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