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

update readme file

Browse Source
This commit is contained in:
deadc0de6
2017-09-15 17:38:48 +02:00
parent fbb2fb2e2c
commit 1700176c70
1 changed files with 21 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

37
README.md
View File

@@ -26,9 +26,11 @@ Features:
* Comparison between local and stored dotfiles * Comparison between local and stored dotfiles
* Handling multiple profiles with different sets of dotfiles * Handling multiple profiles with different sets of dotfiles
* Easy import dotfiles * Easy import dotfiles
* Handle files and directories
* Associate an action to the deployment specific dotfiles * Associate an action to the deployment specific dotfiles
Check the [blog post](https://deadc0de.re/articles/dotfiles.html) for more. Check the [blog post](https://deadc0de.re/articles/dotfiles.html) and
and the [example](#example) for more.
Quick start: Quick start:
```bash ```bash
@@ -54,7 +56,7 @@ git submodule add https://github.com/deadc0de6/dotdrop.git
* [Execute an action when deploying a dotfile](#execute-an-action-when-deploying-a-dotfile) * [Execute an action when deploying a dotfile](#execute-an-action-when-deploying-a-dotfile)
* [All dotfiles for a profile](#all-dotfiles-for-a-profile) * [All dotfiles for a profile](#all-dotfiles-for-a-profile)
* [Include dotfiles from another profile](#include-dotfiles-from-another-profile) * [Include dotfiles from another profile](#include-dotfiles-from-another-profile)
* [Update dotbot](#update-dotbot) * [Update dotdrop](#update-dotdrop)
* [Template](#template) * [Template](#template)
* [Example](#example) * [Example](#example)
@@ -74,15 +76,15 @@ why dotdrop rocks.
The following will create a repository for your dotfiles and The following will create a repository for your dotfiles and
keep dotdrop as a submodules: keep dotdrop as a submodules:
```bash ```bash
mkdir dotfiles; cd dotfiles $ mkdir dotfiles; cd dotfiles
git init $ git init
git submodule add https://github.com/deadc0de6/dotdrop.git $ git submodule add https://github.com/deadc0de6/dotdrop.git
./dotdrop/bootstrap.sh $ ./dotdrop/bootstrap.sh
``` ```
Then install the requirements: Then install the requirements:
```bash ```bash
sudo pip3 install -r dotdrop/requirements.txt $ sudo pip3 install -r dotdrop/requirements.txt
``` ```
Finally import your dotfiles as described [below](#usage). Finally import your dotfiles as described [below](#usage).
@@ -203,9 +205,9 @@ the following entries:
- <action-key> - <action-key>
``` ```
* **profiles** entry: a list of profiles with a list * **profiles** entry: a list of profiles with the different dotfiles that
of dotfiles that need to be deployed for this profile need to be managed
* `profiles`: the dotfiles associated to this profile * `dotfiles`: the dotfiles associated to this profile
* `include`: include all dotfiles from another profile (optional) * `include`: include all dotfiles from another profile (optional)
``` ```
@@ -220,7 +222,7 @@ the following entries:
- ... - ...
``` ```
* **actions** entry: a list of action available * **actions** entry: a list of action
``` ```
<action-key>: <command-to-execute> <action-key>: <command-to-execute>
``` ```
@@ -248,9 +250,9 @@ Dotdrop allows to import dotfiles directly from the
filesystem. It will copy the dotfile and update the filesystem. It will copy the dotfile and update the
config file automatically. config file automatically.
For example to import *$HOME/.xinitrc* For example to import *~/.xinitrc*
```bash ```bash
$ ./dotdrop.sh import $HOME/.xinitrc $ ./dotdrop.sh import ~/.xinitrc
``` ```
@@ -315,7 +317,7 @@ Thus when `f_vimrc` is installed, the command
`vim +VundleClean! +VundleInstall +VundleInstall! +qall` will `vim +VundleClean! +VundleInstall +VundleInstall! +qall` will
be executed. be executed.
## Update dotbot ## Update dotdrop
If installed through the `bootstrap.sh` script, dotdrop is If installed through the `bootstrap.sh` script, dotdrop is
installed as a submodule within your git tree. installed as a submodule within your git tree.
@@ -418,9 +420,12 @@ exec bspwm
{%@@ endif @@%} {%@@ endif @@%}
``` ```
The *if branch* will define which part is deployed based on the
hostname of the host on which dotdrop is run from.
And here's how the config file looks like with this setup. And here's how the config file looks like with this setup.
Of course any combination of the dotfiles (different sets) Of course any combination of the dotfiles (different sets)
can be done once you have more dotfiles to deploy. can be done if more dotfiles have to be deployed.
`config.yaml` file: `config.yaml` file:
```yaml ```yaml
@@ -468,7 +473,7 @@ have inspired me for dotdrop:
* [https://github.com/anishathalye/dotbot](https://github.com/anishathalye/dotbot) * [https://github.com/anishathalye/dotbot](https://github.com/anishathalye/dotbot)
* [https://github.com/tomjnixon/Dotfiles](https://github.com/tomjnixon/Dotfiles) * [https://github.com/tomjnixon/Dotfiles](https://github.com/tomjnixon/Dotfiles)
see also [github does dotfiles](https://dotfiles.github.io/) See also [github does dotfiles](https://dotfiles.github.io/)
# Contribution # Contribution