ferro

Crates.ioferro
lib.rsferro
version0.6.0
sourcesrc
created_at2023-03-08 07:17:15.651094
updated_at2023-03-11 20:02:33.34755
descriptionA lightweight text editor written in Rust
homepage
repositoryhttps://github.com/alexxyu/ferro
max_upload_size
id804325
size141,921
Alex Yu (alexxyu)

documentation

https://alexxyu.github.io/ferro

README

Ferro

Run ferro tests and coverage codecov

A lightweight text editor built in Rust.

Based on Philipp Flenker's Rust text editor tutorial.

Features

  • vim-like navigation controls
  • Syntax highlighting for Rust, Java, and Python (with more languages coming soon)
  • Incremental forward and backward search
  • Search-and-delete / search-and-replace
  • Auto-indentation
  • Built-in calculator for math expressions

Documentation

API documentation is located here.

For reference on controls and usage, see docs/usage.md.

If you're interested in contributing, check out CONTRIBUTING.md.

Installation

Using cargo

The simplest way to install ferro is to run cargo install ferro on your machine. You can then run ferro [file] to start editing!

From source

The following instructions assume that you've already installed Rust.

git clone https://github.com/alexxyu/ferro
cd ferro
cargo build --release

This will generate the binary for ferro in the target/release directory.

Commit count: 82

cargo fmt