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

update doc

Browse Source
This commit is contained in:
deadc0de6
2022-06-03 14:45:49 +02:00
parent 910482f8c8
commit ec135464ed
2 changed files with 18 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@@ -100,7 +100,7 @@ Dotdrop is available on:
# Getting started
[Create a new repository](https://dotdrop.readthedocs.io/en/latest/repository-setup/)
[Create a new repository](https://dotdrop.readthedocs.io/en/latest/getting-started/#repository-setup)
to store your dotfiles with dotdrop. *Init* or *clone* that new repository and
[install dotdrop](https://dotdrop.readthedocs.io/en/latest/installation).
@@ -150,7 +150,7 @@ profiles:
- d_polybar
```
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-config/).
Commit and push your changes with git.
@@ -198,7 +198,7 @@ font2 = "unifont:size=6;0"
You also want to have the correct interface set on the wireless network in
the Polybar config.
Add a [variable](https://dotdrop.readthedocs.io/en/latest/config/#variables)
Add a [variable](https://dotdrop.readthedocs.io/en/latest/config-variables/)
to the config file (In the below example, *home* gets the default `wlan0` value for
the variable `wifi` while *office* gets `wlp2s0`):
```yaml
@@ -286,10 +286,10 @@ That's it, a single repository with all your dotfiles for your different hosts.
For more, see the [docs](https://dotdrop.readthedocs.io):
* [Create actions](https://dotdrop.readthedocs.io/en/latest/config-details/#entry-actions)
* [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)
* [Create actions](https://dotdrop.readthedocs.io/en/latest/config-actions)
* [Use transformations](https://dotdrop.readthedocs.io/en/latest/config-transformations)
* [Use variables](https://dotdrop.readthedocs.io/en/latest/config-variables)
* [Symlink dotfiles](https://dotdrop.readthedocs.io/en/latest/howto/symlink-dotfiles)
* [and more](https://dotdrop.readthedocs.io/en/latest/howto/howto/)
# Documentation

17
docs/installation.md
View File

@@ -1,11 +1,12 @@
# Installation
* [PyPI](https://pypi.org/project/dotdrop/)
* [Homebrew](https://formulae.brew.sh/formula/dotdrop)
* [AUR (stable)](https://aur.archlinux.org/packages/dotdrop/)
* [AUR (git version)](https://aur.archlinux.org/packages/dotdrop-git/)
* [Snapcraft](https://snapcraft.io/dotdrop)
* [Pacstall](https://github.com/pacstall/pacstall-programs/blob/master/packages/dotdrop/dotdrop.pacscript)
* [as a submodule](#as-a-submodule)
* [PyPI package](#pypi-package)
* [Homebrew package](#homebrew-package)
* [AUR packages](#aur-packages)
* [Snap package](#snap-package)
* [From source](#from-source)
* [Pacstall package](https://github.com/pacstall/pacstall-programs/blob/master/packages/dotdrop/dotdrop.pacscript)
## As a submodule
@@ -114,6 +115,8 @@ automatically update dotdrop back to the latest commit.
## PyPI package
[PyPI package](https://pypi.org/project/dotdrop/)
Install dotdrop:
```bash
$ pip3 install dotdrop --user
@@ -139,6 +142,8 @@ Then follow the instructions under [PyPI package](#pypi-package).
## Homebrew package
[Homebrew package](https://formulae.brew.sh/formula/dotdrop)
Install dotdrop from Homebrew with:
```bash
$ brew install dotdrop