Skip to content
This repository has been archived by the owner on Oct 12, 2022. It is now read-only.

Commit

Permalink
Readme updates
Browse files Browse the repository at this point in the history
  • Loading branch information
r-darwish committed Sep 5, 2018
1 parent 3533c95 commit 17f2170
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,12 @@ Arch Linux users can use the [AUR](https://aur.archlinux.org/packages/topgrade/)

macOS users can install topgrade via Homebrew.

Other systems users can either use `cargo install` or use the compiled binaries from the release page.
Other systems users can either use `cargo install` or use the compiled binaries from the release
page.

Topgrade isn't guaranteed to work on Rust versions older than the latest stable release. If you
intend to install Topgrade using Cargo then you should either install Rust using rustup or use a
distribution which ships the latest version of Rust, such as Arch Linux.

## Usage
Just run `topgrade`. It will run the following steps:
Expand Down Expand Up @@ -69,6 +74,8 @@ Just run `topgrade`. It will run the following steps:
Topgrade already runs inside tmux. This is useful when using topgrade on remote systems.
* `-n/--dry-run` - Print what should be run.
* `--no-system` - Skip the system upgrade phase.
* `--no-git-repos` - Don't pull custom git repositories.
* `--no-emacs` - Don't upgrade Emacs packages or configuration files.

## Customization
You can place a configuration file at `~/.config/topgrade.toml` (on macOS `~/Library/Preferences/topgrade.toml`).. Here's an example:
Expand Down

0 comments on commit 17f2170

Please sign in to comment.