docs: add configuration examples to readme #42
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
virchau13
requested changes
Mar 5, 2021
I don't think this is a good idea to include right now. This functionality is currently untested and also goes against the intended functionality. |
virchau13
requested changes
Mar 11, 2021
README.md
Outdated
|
|
||
| Variant expressions, denoted with brackets (`[]`), are a shorthand way to set multiple paths. | ||
|
|
||
| Symlink: |
There was a problem hiding this comment.
This should be changed to "This code can be shortened by using a variant expression..." or similar.
|
|
||
| Match expressions, denoted with braces (`{}`), allow to conditionally sync files based on a system's operating system and host. | ||
|
|
||
| Conditionally symlink by os and host: |
There was a problem hiding this comment.
Explain what this does by giving specific examples using OS & host.
| Linting: | ||
|
|
||
| $ cargo check | ||
| $ cargo clippy --all-targets --all-features |
There was a problem hiding this comment.
You may want to add that our automatic CI checks fmt, clippy, and test.
virchau13
requested changes
Mar 12, 2021
README.md
Outdated
| $ git clone [email protected]:plamorg/ambit.git | ||
| $ cd ambit | ||
| $ cargo install --path . | ||
| Symlink `${HOME}/host.txt -> ${AMBIT_REPO_PATH}/a/repo.txt`: |
There was a problem hiding this comment.
The -> should not be part of the monospaced font.
Suggested change
| Symlink `${HOME}/host.txt -> ${AMBIT_REPO_PATH}/a/repo.txt`: | |
| Symlink `${HOME}/host.txt` to `${AMBIT_REPO_PATH}/a/repo.txt`: |
README.md
Outdated
Comment on lines
98
to
101
| * `${HOME}/.config/bat/bat.conf -> ${AMBIT_REPO_PATH}/.config/bat/bat.conf` | ||
| * `${HOME}/.config/nvim/init.vim -> ${AMBIT_REPO_PATH}/.config/nvim/init.vim` | ||
| * `${HOME}/.config/kitty/kitty.conf -> ${AMBIT_REPO_PATH}/.config/kitty/kitty.conf` | ||
| * `${HOME}/.config/kitty/theme.conf -> ${AMBIT_REPO_PATH}/.config/kitty/theme.conf` |
README.md
Outdated
|
|
||
| .config/ambit/config.ambit; | ||
|
|
||
| #### Variant Expression |
There was a problem hiding this comment.
Suggested change
| #### Variant Expression | |
| #### Variant expressions |
virchau13
approved these changes
Mar 12, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR primarily adds configuration examples to
README.mdand some general documentation improvements.