Skip to content

Commit

Permalink
Release fixes (#304)
Browse files Browse the repository at this point in the history
Release fixes
  • Loading branch information
twpayne committed May 18, 2019
2 parents 54b09c2 + 013e289 commit 7d37a3b
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 17 deletions.
2 changes: 2 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -44,12 +44,14 @@ pre-release-checks: strict-lint
.PHONY: release
release:
goreleaser release \
--rm-dist \
${GORELEASER_FLAGS}

.PHONY: release-snap
release-snap:
goreleaser release \
--config=goreleaser/goreleaser.snap.yaml \
--rm-dist \
--skip-publish \
${GORELEASER_FLAGS}
for snap in dist/*.snap ; do \
Expand Down
34 changes: 17 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,21 @@ Card](https://goreportcard.com/badge/github.com/twpayne/chezmoi)](https://gorepo

Manage your dotfiles across multiple machines, securely.

* [Documentation](#documentation)
* [What does chezmoi do and why should I use it?](#what-does-chezmoi-do-and-why-should-i-use-it)
* [Features](#features)
* [I already have a system to manage my dotfiles, why should I use chezmoi?](#i-already-have-a-system-to-manage-my-dotfiles-why-should-i-use-chezmoi)
* [Documentation](#documentation)
* [Related projects](#related-projects)
* [License](#license)

## Documentation

* [Installation guide](docs/INSTALL.md).
* [Quick start guide](docs/QUICKSTART.md).
* [How-to guide](docs/HOWTO.md) for achieving specific tasks.
* [FAQ](docs/FAQ.md) for questions that aren't answered elsewhere.
* [Reference](docs/REFERENCE.md) for a complete description of chezmoi.

## What does chezmoi do and why should I use it?

chezmoi helps you manage your personal configuration files (dotfiles) across
Expand Down Expand Up @@ -69,7 +77,8 @@ system with a single account then you don't need chezmoi. Otherwise, read on...
that state. What you want is what you get.

* Fast and easy to use: chezmoi runs in fractions of a second and makes most
day-to-day operations one line commands.
day-to-day operations one line commands, including installation,
initialization, and keeping your machines up-to-date.

## I already have a system to manage my dotfiles, why should I use chezmoi?

Expand All @@ -88,31 +97,22 @@ system with a single account then you don't need chezmoi. Otherwise, read on...
configuration.

* If your system stores secrets in plain text, then your dotfiles repository
must be private. With chezmoi you never need to store secrets in your
repository, so you can make it public. You can check out your repository on
your work machine and not fear that this will give your work IT department
access to your personal data.
must be private. With chezmoi you can store secrets in your password manager,
so you can make your dotfiles public. You can share your repository between
your personal and work machines, without your work machine and not fear that
this will give your work IT department access to your personal secrets.

* If your system was written by you for your personal use, then it probably has
the minimum functionality that you need. chezmoi includes a wide range of
functionality out-of-the-box, including dry run and diff modes.
functionality out-of-the-box, including dry run and diff modes, conflict
resolution, and running scripts.

* All systems suffer from the "bootstrap" problem: you need to install your
system before you can install your dotfiles. chezmoi provides one-line
installs, statically-linked binaries, packages for many Linux and BSD
distributions, Homebrew formulae, and a initial config file generation
mechanism to make overcoming the bootstrap problem as painless as possible.

## Documentation

chezmoi includes five types of documentation:

* An [installation guide](docs/INSTALL.md).
* A [quick start guide](docs/QUICKSTART.md).
* A [how-to guide](docs/HOWTO.md) for achieving specific tasks.
* An [FAQ](docs/FAQ.md) for questions that aren't answered elsewhere.
* A [reference](docs/REFERENCE.md) for a complete description of chezmoi.

## Related projects

See [`dotfiles.github.io`](https://dotfiles.github.io/).
Expand Down

0 comments on commit 7d37a3b

Please sign in to comment.