diff --git a/README.md b/README.md index a35a161..484be2b 100644 --- a/README.md +++ b/README.md @@ -128,13 +128,13 @@ Completion scripts exist for `bash`, `zsh` and `fish`, see [the related doc](com # Getting started -Create a new repository to store your dotfiles with dotdrop. *Init* or *clone* -that new repository and +[Create a new repository](https://dotdrop.readthedocs.io/en/latest/repository-setup/) +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). 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 -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* ```bash @@ -146,7 +146,7 @@ Dotdrop does two things: * Copy the dotfiles in the *dotpath* directory (defined in `config.yaml`, defaults to *dotfiles*) * 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 ```yaml @@ -180,7 +180,7 @@ profiles: For a description of the different fields and their use, 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, 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 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 -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 … profiles: @@ -248,7 +248,7 @@ exec bspwm The *if branch* on above template examples will define 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). 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 variables](https://dotdrop.readthedocs.io/en/latest/config/#variables) * [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). diff --git a/docs/repository-setup.md b/docs/repository-setup.md index 157e94e..08d5abd 100644 --- a/docs/repository-setup.md +++ b/docs/repository-setup.md @@ -1,6 +1,6 @@ # 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`) and a directory containing all your dotfiles managed by dotdrop. ```bash @@ -39,4 +39,4 @@ alias dotdrop='dotdrop --cfg=' For more info on the config file format, see [the config doc](config.md). Finally start using dotdrop with `dotdrop --help`. See the [usage doc](usage.md) -and [the example](https://github.com/deadc0de6/dotdrop/blob/master/README.md#getting-started). \ No newline at end of file +and [the example](https://github.com/deadc0de6/dotdrop/blob/master/README.md#getting-started).