psi-jack/dotbot
1
0
Fork 0
mirror of synced 2024-12-04 13:25:34 -05:00
Code Issues Releases Wiki Activity

Merge d87c0f2c41 into 720206578a

Browse source
This commit is contained in:
Konstantin Ostrovskii 2024-05-14 07:41:35 -05:00 committed by GitHub
commit 897dc86371
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 12 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -1,4 +1,4 @@
# Dotbot [![Build Status](https://github.com/anishathalye/dotbot/workflows/CI/badge.svg)](https://github.com/anishathalye/dotbot/actions?query=workflow%3ACI) [![Coverage](https://codecov.io/gh/anishathalye/dotbot/branch/master/graph/badge.svg)](https://app.codecov.io/gh/anishathalye/dotbot) [![PyPI](https://img.shields.io/pypi/v/dotbot.svg)](https://pypi.org/pypi/dotbot/) [![Python 3.6+](https://img.shields.io/badge/python-3.6%2B-blue)](https://pypi.org/pypi/dotbot/)
# Dotbot [![Build Status](https://github.com/anishathalye/dotbot/workflows/CI/badge.svg)](https://github.com/anishathalye/dotbot/actions?query=workflow%3ACI) [![Coverage](https://codecov.io/gh/anishathalye/dotbot/branch/master/graph/badge.svg)](https://app.codecov.io/gh/anishathalye/dotbot) [![PyPI](https://img.shields.io/pypi/v/dotbot?logo=pypi)](https://pypi.org/pypi/dotbot/) [![Homebrew](https://img.shields.io/homebrew/v/dotbot?logo=homebrew)](https://formulae.brew.sh/formula/dotbot) [![Python 3.6+](https://img.shields.io/badge/python-3.6%2B-blue?logo=python)](https://pypi.org/pypi/dotbot/)
Dotbot makes installing your dotfiles as easy as `git clone $url && cd dotfiles
&& ./install`, even on a freshly installed system!
@ -89,6 +89,8 @@ submodule; be sure to commit your changes before running `./install`, otherwise
the old version of Dotbot will be checked out by the install script. If using a
subrepo, run `git fetch && git checkout origin/master` in the Dotbot directory.
### PyPI and Homebrew
If you prefer, you can install Dotbot from [PyPI] and call it as a command-line
program:
@ -97,7 +99,14 @@ pip install dotbot
touch install.conf.yaml
```
In this case, rather than running `./install`, you can invoke Dotbot with
For [Homebrew] call it:
```bash
brew install dotbot
touch install.conf.yaml
```
In these cases, rather than running `./install`, you can invoke Dotbot with
`dotbot -c <path to configuration file>`.
### Full Example
@ -467,6 +476,7 @@ Copyright (c) Anish Athalye. Released under the MIT License. See
[LICENSE.md][license] for details.
[PyPI]: https://pypi.org/project/dotbot/
[Homebrew]: https://formulae.brew.sh/formula/dotbot
[init-dotfiles]: https://github.com/Vaelatern/init-dotfiles
[dotfiles-template]: https://github.com/anishathalye/dotfiles_template
[inspiration]: https://github.com/anishathalye/dotbot/wiki/Users