summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJiayi Zhao <jeff.no.zhao@gmail.com>2019-01-07 21:54:02 -0500
committerJiayi Zhao <jeff.no.zhao@gmail.com>2019-01-07 21:54:02 -0500
commit8506ff208fc988a2b8f08a9a28a36c80362aa0be (patch)
tree590056023cbcba9563d2f84e5970fd90ea7da4dc
parentf579b0f9995cee4e5a9c0c434785739df8545da7 (diff)
parentcfa9eaee60181ccc956c04a271bb63b08aa72229 (diff)
Merge branch 'master' into dev
-rw-r--r--README.md23
1 files changed, 10 insertions, 13 deletions
diff --git a/README.md b/README.md
index 3b1053b..5efb0fb 100644
--- a/README.md
+++ b/README.md
@@ -24,25 +24,22 @@ $ 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 [keymapll.rs](https://github.com/kamiyaa/joshuto/blob/master/src/joshuto/keymapll.rs) for keycodes
- - 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)
- - for opening files with applications
- - **currently causes program to be unable to open any files when this config is missing**
+ - [mimetype.toml](https://github.com/kamiyaa/joshuto/blob/master/config/mimetype.toml) (**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
-Create a pull request please :)
+Please create a pull request :)
## Features/Bugs
-Create an ssue please :)
+Please create an issue :)