mirrors/dotdrop
1
0
Fork 0
mirror of https://github.com/deadc0de6/dotdrop.git synced 2026-02-10 01:44:16 +00:00
Code Activity

update doc

Browse Source
This commit is contained in:
deadc0de6
2020-10-04 21:45:34 +02:00
parent ce84e9dd96
commit 6d62103486
2 changed files with 10 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@@ -128,13 +128,13 @@ Completion scripts exist for `bash`, `zsh` and `fish`, see [the related doc](com
# Getting started # Getting started
Create a new repository to store your dotfiles with dotdrop. *Init* or *clone* [Create a new repository](https://dotdrop.readthedocs.io/en/latest/repository-setup/)
that new repository and to store your dotfiles with dotdrop. *Init* or *clone* that new repository and
[install dotdrop](https://dotdrop.readthedocs.io/en/latest/installation/#as-a-submodule). [install dotdrop](https://dotdrop.readthedocs.io/en/latest/installation/#as-a-submodule).
Then import any dotfiles (files or directories) you want to manage with dotdrop. Then import any dotfiles (files or directories) you want to manage with dotdrop.
You can either use the default profile (which resolves to the *hostname* of the host You can either use the default profile (which resolves to the *hostname* of the host
your running dotdrop on) or provide it specifically using the switch `-p --profile`. you are running dotdrop on) or provide it specifically using the switch `-p --profile`.
Import dotfiles on host *home* Import dotfiles on host *home*
```bash ```bash
@@ -146,7 +146,7 @@ Dotdrop does two things:
* Copy the dotfiles in the *dotpath* directory * Copy the dotfiles in the *dotpath* directory
(defined in `config.yaml`, defaults to *dotfiles*) (defined in `config.yaml`, defaults to *dotfiles*)
* Create the associated entries in the `config.yaml` file * Create the associated entries in the `config.yaml` file
(in `dotfiles` and in `profiles`) (in the `dotfiles` and `profiles` entries)
Your config file will look something similar to this Your config file will look something similar to this
```yaml ```yaml
@@ -180,7 +180,7 @@ profiles:
For a description of the different fields and their use, For a description of the different fields and their use,
see the [config doc](https://dotdrop.readthedocs.io/en/latest/config-format/). see the [config doc](https://dotdrop.readthedocs.io/en/latest/config-format/).
Commit and push your changes. Commit and push your changes with git.
Then go to another host where your dotfiles need to be managed as well, Then go to another host where your dotfiles need to be managed as well,
clone the previously setup repository clone the previously setup repository
@@ -192,7 +192,7 @@ $ dotdrop compare --profile=home
Now you might want to adapt the `config.yaml` file to your likings on Now you might want to adapt the `config.yaml` file to your likings on
that second host. Let's say for example that you only want `d_polybar` and that second host. Let's say for example that you only want `d_polybar` and
`f_xinitrc` to be deployed on that second host. You would then change your config `f_xinitrc` to be deployed on that second host. You would then change your config
to something like this (considering that second host's hostname is *office*): to something like this (considering that the second host's hostname is *office*):
```yaml ```yaml
… …
profiles: profiles:
@@ -248,7 +248,7 @@ exec bspwm
The *if branch* on above template examples will define The *if branch* on above template examples will define
which part is deployed based on the which part is deployed based on the
hostname of the host on which dotdrop is run from. hostname of the host on which dotdrop is run from
(or the selected profile). (or the selected profile).
When done, you can install your dotfiles using When done, you can install your dotfiles using
@@ -267,7 +267,7 @@ You can then
* [use transformations](https://dotdrop.readthedocs.io/en/latest/config-details/#entry-transformations) * [use transformations](https://dotdrop.readthedocs.io/en/latest/config-details/#entry-transformations)
* [use variables](https://dotdrop.readthedocs.io/en/latest/config/#variables) * [use variables](https://dotdrop.readthedocs.io/en/latest/config/#variables)
* [symlink dotfiles](https://dotdrop.readthedocs.io/en/latest/config/#symlink-dotfiles) * [symlink dotfiles](https://dotdrop.readthedocs.io/en/latest/config/#symlink-dotfiles)
* [and more](https://dotdrop.readthedocs.io) * [and more](https://dotdrop.readthedocs.io/en/latest/howto/howto/)
For more options see `dotdrop --help` and the [documentation](https://dotdrop.readthedocs.io). For more options see `dotdrop --help` and the [documentation](https://dotdrop.readthedocs.io).

2
docs/repository-setup.md
View File

@@ -1,6 +1,6 @@
# Repository setup # Repository setup
Either create a repository on your prefered platform and clone it or create one locally. Either create a git repository on your prefered platform and clone it or create one locally.
This repository will contain two main elements, dotdrop's config file (`config.yaml`) This repository will contain two main elements, dotdrop's config file (`config.yaml`)
and a directory containing all your dotfiles managed by dotdrop. and a directory containing all your dotfiles managed by dotdrop.
```bash ```bash