Skip to content

Latest commit

 

History

History
100 lines (62 loc) · 2.36 KB

README.md

File metadata and controls

100 lines (62 loc) · 2.36 KB
Raw

twin-commander

ci-status

A text mode twin-panel file manager for Redox OS inspired by Midnight and Total Commander.

Alt text

About the project

This is my pet project for learning the Rust programming language. I develop this application to be my daily driver for managing files and for showcase some custom programs written in Rust and fill the gaps of the lacking/missing applications in the userspace for the Redox OS. If you are a fan of 'Lets Reimplement The Whole Universe in Rust' too, stay with me

Features

  • Basic everyday CRUD file operations
  • compact, small footprint (memory usage around ~3 MB, final binary size ~ 700kb)

See the Issues for upcoming features, like:

  • Themes
  • Archives support
  • Remote protocols
  • Plugins

and many more (who knows?)

Supported platforms

Twin Commander currently supports only GNU/Linux distributions and the Redox OS.

Windows is not supported due to one of the backend of the terminal handling library, specifically termion (termion only supports GNU/Linux and Redox OS).

The other backend of tui-rs, crossterm has no support for Redox OS, and i want to use this app in Redox OS.

So, choices are made.

Getting Started

To set up a local copy of the project on your machine, follow the next steps:

Clone the repository:

git clone  https://github.com/kivimango/twin-commander.git

or using the tarball:

# Download the tarball
wget https://github.com/kivimango/twin-commander/archive/refs/heads/master.zip

# Unzip it
unzip master.zip

# and make your way into the project's folder with
cd twin-commander

Building from source

Please refer the Getting started section. Once your local copy of the project is set up, you can build the project from source by running the

# for debug mode
cargo build

or the

# for release mode
cargo build -r

command.

Installation

Im planning releasing on crates.io once a MVP is ready.

When it is published, the following command

cargo install twin-commander

will install a binary of this application.

Development

Want to contribute? Great!

License

Apache License 2.0