Skip to content

Commit

Permalink
docs: Make features and portability more prominent on home page
Browse files Browse the repository at this point in the history
  • Loading branch information
twpayne committed Sep 9, 2024
1 parent 94a27ee commit 2a64e42
Showing 1 changed file with 12 additions and 4 deletions.
16 changes: 12 additions & 4 deletions assets/chezmoi.io/docs/index.md.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,19 @@ Manage your dotfiles across multiple diverse machines, securely.
The latest version of chezmoi is {{ $version }} ([release notes]({{
$latestRelease.HTMLURL }}), [release history](reference/release-history.md)).

## What does chezmoi do?

chezmoi helps you manage your personal configuration files (dotfiles, like
`~/.gitconfig`) across multiple machines.

chezmoi provides many features beyond symlinking or using a bare git repo
including: templates (to handle small differences between machines), password
manager support (to store your secrets securely), importing files from archives
(great for shell and editor plugins), full file encryption (using gpg or age),
and running scripts (to handle everything else).
including:

* templates (to handle small differences between machines)
* password manager support (to store your secrets securely)
* importing files from archives (great for shell and editor plugins)
* full file encryption (using gpg or age)
* running scripts (to handle everything else)

With chezmoi, pronounced /ʃeɪ mwa/ (shay-moi), you can install chezmoi and your
dotfiles from your GitHub dotfiles repo on a new, empty machine with a single
Expand All @@ -33,6 +38,9 @@ Updating your dotfiles on any machine is a single command:
$ chezmoi update
```

chezmoi runs on all popular operating systems, is distributed as a single
statically-linked binary with no dependencies, and does not require root access.

## How do I start with chezmoi?

[Install chezmoi](install.md) then read the [quick start guide](quick-start.md).
Expand Down

0 comments on commit 2a64e42

Please sign in to comment.