mirrors/dotdrop
1
0
Fork 0
mirror of https://github.com/deadc0de6/dotdrop.git synced 2026-02-05 06:48:49 +00:00
Code Activity

doc update structure

Browse Source
This commit is contained in:
deadc0de6
2020-09-14 21:07:49 +02:00
parent 3d7c93b2c6
commit e8eefca256
20 changed files with 824 additions and 843 deletions
Download Patch File Download Diff File Expand all files Collapse all files

57
docs/installation.md
View File

@@ -4,7 +4,7 @@ Installing dotdrop [as a submodule](#as-a-submodule) is the recommended way.
If you want to keep your python environment clean, use the virtualenv installation instructions
(see [As a submodule in a virtualenv](#as-a-submodule-in-a-virtualenv) and
[With pypi in a virtualenv](#with-pypi-in-a-virtualenv)).
[Pypi package in a virtualenv](#pypi-package-in-a-virtualenv)).
In that case, the virtualenv environment might need to be loaded before any attempt to use dotdrop.
## As a submodule
@@ -66,16 +66,16 @@ $ ./dotdrop.sh --help
Then follow the instructions under [As a submodule](#as-a-submodule).
## With pypi
## Pypi package
Install dotdrop
```bash
$ pip3 install dotdrop --user
```
and then [setup your repository](#setup-your-repository).
and then [setup your repository](repository-setup.md).
## With pypi in a virtualenv
## Pypi package in a virtualenv
Install dotdrop in a virtualenv from pypi
```bash
@@ -91,7 +91,7 @@ $ source env/bin/activate
$ dotdrop --help
```
Then follow the instructions under [With pypi](#with-pypi).
Then follow the instructions under [Pypi package](#pypi-package).
## Aur packages
@@ -99,7 +99,7 @@ Dotdrop is available on aur:
* stable: <https://aur.archlinux.org/packages/dotdrop/>
* git version: <https://aur.archlinux.org/packages/dotdrop-git/>
Then follow the [doc to setup your repository](#setup-your-repository).
Then follow the [doc to setup your repository](repository-setup.md).
## Snap package
@@ -110,7 +110,7 @@ Install it with
snap install dotdrop
```
Then follow the [doc to setup your repository](#setup-your-repository).
Then follow the [doc to setup your repository](repository-setup.md).
## Dependencies
@@ -150,49 +150,6 @@ Or if installed through pypi:
$ pip3 install dotdrop --upgrade --user
```
## Setup your repository
Either create a 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
## clone your repository (my-dotfiles)
$ git clone <some-url>/my-dotfiles
$ cd my-dotfiles
## within the repository create a directory to store your dotfiles
## (refered by "dotpath" in the config, which defaults to "dotfiles")
$ mkdir dotfiles
```
Then add a config file. You can get a
[minimal config file](https://github.com/deadc0de6/dotdrop/blob/master/config.yaml)
from dotdrop's repository with
```bash
$ wget https://raw.githubusercontent.com/deadc0de6/dotdrop/master/config.yaml
```
It is recommended to store your config file directly within your repository
(*my-dotfiles* in the example above) but you could save it in different places if you wish,
see [config location](config.md#location) for more.
```bash
$ tree my-dotfiles
my-dotfiles
├── config.yaml
└── dotfiles
```
If your config file is in an exotic location, you can add an alias
in your preferred shell to call dotdrop with the config file path argument.
```
alias dotdrop='dotdrop --cfg=<path-to-your-config.yaml>'
```
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).
## Shell completion
Completion scripts exist for `bash`, `zsh` and `fish`,