summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorUsairim Isani <usairim.isani@outlook.com>2020-07-27 20:24:44 +0500
committerUsairim Isani <usairim.isani@outlook.com>2020-07-27 20:24:44 +0500
commitfc41fbc57fade86cce5d30b683145dc86054c06f (patch)
tree0e8a516fae9d95b859346fb0e7b2dff479dbbfa5 /README.md
parente46101071ee2e1867a3b9b66ab8ae113f1974b56 (diff)
Github workflows and Test Badge.
Diffstat (limited to 'README.md')
-rw-r--r--README.md46
1 files changed, 31 insertions, 15 deletions
diff --git a/README.md b/README.md
index 4d3b86b..463f697 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,5 @@
+![Rust](https://github.com/kamiyaa/joshuto/workflows/Rust/badge.svg)
+
# joshuto
[ranger](https://github.com/ranger/ranger)-like terminal file manager written in Rust.
@@ -5,62 +7,76 @@
![Alt text](screenshot.png?raw=true "joshuto")
## Dependencies
- - [cargo](https://github.com/rust-lang/cargo/) >= 0.41.0
- - [rustc](https://www.rust-lang.org/) >= 1.41.0
+
+- [cargo](https://github.com/rust-lang/cargo/) >= 0.41.0
+- [rustc](https://www.rust-lang.org/) >= 1.41.0
Also see [Cargo.toml](https://github.com/kamiyaa/joshuto/blob/master/Cargo.toml)
## Building
+
```
~$ cargo build
```
## Installation
+
#### For single user
+
```
~$ cargo install --path=. --force
```
+
#### System wide
+
```
~# cargo install --path=. --force --root=/usr/local # /usr also works
```
## Usage
+
```
~ $ joshuto
```
## Configuration
+
Place config files inside `$XDG_CONFIG_HOME/joshuto` (usually `$HOME/.config/joshuto/` for GNU/Linux).
Joshuto can currently be configured using the following files:
+
#### [joshuto.toml](https://github.com/kamiyaa/joshuto/blob/master/config/joshuto.toml)
- - general configurations
+
+- general configurations
#### [keymap.toml](https://github.com/kamiyaa/joshuto/blob/master/config/keymap.toml)
- - for keybindings, please take a look at [keymap.rs](https://github.com/kamiyaa/joshuto/blob/master/src/config/keymap.rs#L102) for non-printable keys
- - for commands, please take a look at commands/[mod.rs](https://github.com/kamiyaa/joshuto/blob/master/src/commands/mod.rs#L73) for available commands
+
+- for keybindings, please take a look at [keymap.rs](https://github.com/kamiyaa/joshuto/blob/master/src/config/keymap.rs#L102) for non-printable keys
+- for commands, please take a look at commands/[mod.rs](https://github.com/kamiyaa/joshuto/blob/master/src/commands/mod.rs#L73) for available commands
#### [mimetype.toml](https://github.com/kamiyaa/joshuto/blob/master/config/mimetype.toml)
- - for opening files with applications
+
+- for opening files with applications
#### [theme.toml](https://github.com/kamiyaa/joshuto/blob/master/config/theme.toml)
- - color customizations
+- color customizations
## Contributing
+
Please create a pull request :)
## Features/Bugs
+
Please create an issue :)
## TODOs
- - [x] Migrate to [tui-rs](https://github.com/fdehau/tui-rs)
- - [x] Tab support
- - [x] Ctrl/Shift/Alt support
- - [x] Asynch File IO (cut/copy/paste/delete/rename) (in progress)
- - [ ] Built-in command line (in progress)
- - [ ] File previews (in progress)
- - [ ] Tab autocomplete (in progress)
- - [x] Bulk rename
+- [x] Migrate to [tui-rs](https://github.com/fdehau/tui-rs)
+- [x] Tab support
+- [x] Ctrl/Shift/Alt support
+- [x] Asynch File IO (cut/copy/paste/delete/rename) (in progress)
+- [ ] Built-in command line (in progress)
+- [ ] File previews (in progress)
+- [ ] Tab autocomplete (in progress)
+- [x] Bulk rename