summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJiayi Zhao <jeff.no.zhao@gmail.com>2019-01-07 21:51:49 -0500
committerGitHub <noreply@github.com>2019-01-07 21:51:49 -0500
commitcfa9eaee60181ccc956c04a271bb63b08aa72229 (patch)
tree2de5ddbeb76b2162043a39f1daad2ac8cc0c2197
parent864258c4acc9ecb22fa63e859df0294b9d3b9a1f (diff)
Update README.md
-rw-r--r--README.md20
1 files changed, 8 insertions, 12 deletions
diff --git a/README.md b/README.md
index dc8145f..5efb0fb 100644
--- a/README.md
+++ b/README.md
@@ -24,23 +24,19 @@ $ cargo build
```
## Configuration
+Place config files inside `$XDG_CONFIG_DIR/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
+ - [joshuto.toml](https://github.com/kamiyaa/joshuto/blob/master/config/joshuto.toml)
+ - 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/joshuto/config/keymap.rs) for non-printable keys
- - for commands
- - please take a look at [command.rs](https://github.com/kamiyaa/joshuto/blob/master/src/joshuto/command.rs) for available commands
+ - [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/joshuto/config/keymap.rs) for non-printable keys
+ - for commands, please take a look at [command.rs](https://github.com/kamiyaa/joshuto/blob/master/src/joshuto/command.rs) for available commands
-[mimetype.toml](https://github.com/kamiyaa/joshuto/blob/master/config/mimetype.toml)
+ - [mimetype.toml](https://github.com/kamiyaa/joshuto/blob/master/config/mimetype.toml) (**currently unstable and is subject to changes**)
+ - for opening files with applications
-**currently unstable and is subject to changes**
- - for opening files with applications
-
-Place these config files in your `$XDG_CONFIG_DIR/joshuto` (usually `$HOME/.config/joshuto/`)
## Contributing
Please create a pull request :)