diff options
| author | Jiayi Zhao <jeff.no.zhao@gmail.com> | 2019-02-05 20:58:17 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-02-05 20:58:17 -0500 |
| commit | 3e6cdd50377e2cb888ee17fd5cb18300113e26ed (patch) | |
| tree | c0c5d2d4b8fd34aff6485ea814218ab24861073e /README.md | |
| parent | 1427070950462fdfba92dc08f5e477ebb87da0ad (diff) | |
Update README.md
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 32 |
1 files changed, 20 insertions, 12 deletions
@@ -12,10 +12,19 @@ Currently a work in progress. Also see [Cargo.toml](https://github.com/kamiyaa/joshuto/blob/master/Cargo.toml) +## Building +``` +~$ cargo build +``` + ## Installation +#### For single user ``` -$ cargo build -# cargo install --root=/usr/local --force +~$ cargo install --force +``` +#### System wide +``` +~# cargo install --root=/usr/local --force # /usr also works ``` ## Usage @@ -27,19 +36,18 @@ $ cargo build 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 - - [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) - - for opening files with applications +#### [mimetype.toml](https://github.com/kamiyaa/joshuto/blob/master/config/mimetype.toml) + - for opening files with applications - - [theme.toml](https://github.com/kamiyaa/joshuto/blob/master/config/theme.toml) - - color customizations +#### [theme.toml](https://github.com/kamiyaa/joshuto/blob/master/config/theme.toml) + - color customizations ## Contributing |