admin/topgrade
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Readme updates

Browse Source
This commit is contained in:
Roey Darwish Dror
2018-09-05 11:23:04 +03:00
parent 3533c95b78
commit 17f2170777
1 changed files with 8 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@@ -17,7 +17,12 @@ Arch Linux users can use the [AUR](https://aur.archlinux.org/packages/topgrade/)
macOS users can install topgrade via Homebrew. 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 ## Usage
Just run `topgrade`. It will run the following steps: Just run `topgrade`. It will run the following steps:
@@ -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. Topgrade already runs inside tmux. This is useful when using topgrade on remote systems.
* `-n/--dry-run` - Print what should be run. * `-n/--dry-run` - Print what should be run.
* `--no-system` - Skip the system upgrade phase. * `--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 ## Customization
You can place a configuration file at `~/.config/topgrade.toml` (on macOS `~/Library/Preferences/topgrade.toml`).. Here's an example: You can place a configuration file at `~/.config/topgrade.toml` (on macOS `~/Library/Preferences/topgrade.toml`).. Here's an example: