diff options
-rw-r--r-- | README.md | 23 |
1 files changed, 10 insertions, 13 deletions
@@ -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 :) |