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

Enhance the README (#82)

Browse Source
This commit is contained in:
Pascal Jufer
2022-10-27 16:38:44 +02:00
committed by GitHub
parent 639c7fd422
commit 3a5cc8a388
1 changed files with 35 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

50
README.md
View File

@@ -1,58 +1,76 @@
![Topgrade](doc/topgrade.png) <div align="center">
<!--- <img alt="Topgrade" src="doc/topgrade.png" width="850px">
![GitHub release](https://img.shields.io/github/release/r-darwish/topgrade.svg)
[![Crates.io](https://img.shields.io/crates/v/topgrade.svg)](https://crates.io/crates/topgrade)
[![AUR](https://img.shields.io/aur/version/topgrade.svg)](https://aur.archlinux.org/packages/topgrade/)
![homebrew](https://img.shields.io/homebrew/v/topgrade.svg) -->
--->
![Demo](doc/screenshot.gif) <!--
<a href="https://github.com/topgrade-rs/topgrade/releases"><img alt="GitHub Release" src="https://img.shields.io/github/release/r-darwish/topgrade.svg"></a>
<a href="https://crates.io/crates/topgrade"><img alt="crates.io" src="https://img.shields.io/crates/v/topgrade.svg"></a>
<a href="https://aur.archlinux.org/packages/topgrade"><img alt="AUR" src="https://img.shields.io/aur/version/topgrade.svg"></a>
<a href="https://formulae.brew.sh/formula/topgrade"><img alt="Homebrew" src="https://img.shields.io/homebrew/v/topgrade.svg"></a>
-->
## Fork <img alt="Demo" src="doc/screenshot.gif" width="550px">
This is a fork of [topgrade by r-darwish](https://github.com/r-darwish/topgrade) to keep it maintained. </div>
## Introduction
> **Note**
> This is a fork of [topgrade by r-darwish](https://github.com/r-darwish/topgrade) to keep it maintained.
Keeping your system up to date usually involves invoking multiple package managers. Keeping your system up to date usually involves invoking multiple package managers.
This results in big, non-portable shell one-liners saved in your shell. This results in big, non-portable shell one-liners saved in your shell.
To remedy this, _topgrade_ detects which tools you use and runs the appropriate commands to update them. To remedy this, **topgrade** detects which tools you use and runs the appropriate commands to update them.
## Installation ## Installation
- Arch Linux: [AUR](https://aur.archlinux.org/packages/topgrade/) package.
- Arch Linux: [AUR](https://aur.archlinux.org/packages/topgrade) package.
- NixOS: _topgrade_ package in `nixpkgs`. - NixOS: _topgrade_ package in `nixpkgs`.
- macOS: [Homebrew](https://brew.sh/) or [MacPorts](https://www.macports.org/install.php). - macOS: [Homebrew](https://formulae.brew.sh/formula/topgrade) or [MacPorts](https://ports.macports.org/port/topgrade/).
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.
The compiled binaries contain a self-upgrading feature. The compiled binaries contain a self-upgrading feature.
Topgrade requires Rust 1.51 or above. Topgrade requires Rust 1.51 or above.
## Documentation[WIP] ## Documentation
> **Warning**
> Work in Progress
You can visit the documentation at [topgrade-rs.github.io](https://topgrade-rs.github.io/) . You can visit the documentation at [topgrade-rs.github.io](https://topgrade-rs.github.io/) .
## Usage ## Usage
Just run `topgrade`. Just run `topgrade`.
See [the wiki](https://github.com/r-darwish/topgrade/wiki/Step-list) for the list of things Topgrade supports. See [the wiki](https://github.com/r-darwish/topgrade/wiki/Step-list) for the list of things Topgrade supports.
## Customization ## Customization
See `config.example.toml` for an example configuration file. See `config.example.toml` for an example configuration file.
### Configuration path ### Configuration path
The configuration should be placed in the following paths depending by the operating system: The configuration should be placed in the following paths depending by the operating system:
* **Windows** - `%APPDATA%/topgrade.toml` - **Windows** - `%APPDATA%/topgrade.toml`
* **macOS** and **other Unix systems** - `${XDG_CONFIG_HOME:-~/.config}/topgrade.toml` - **macOS** and **other Unix systems** - `${XDG_CONFIG_HOME:-~/.config}/topgrade.toml`
## Contribution ## Contribution
### Problems or missing features? ### Problems or missing features?
Open a new Issue describing your problem and if possible with a possible solution. Open a new Issue describing your problem and if possible with a possible solution.
### Missing a feature or found an unsupported tool/distro? ### Missing a feature or found an unsupported tool/distro?
Just let us now what you are missing by opening an issue. Just let us now what you are missing by opening an issue.
For tools please open an Issue describing the tool, which platforms it supports and if possible, give us an example of its usage. For tools please open an Issue describing the tool, which platforms it supports and if possible, give us an example of its usage.
### Want to contribute to the code? ### Want to contribute to the code?
Just fork the repository and start coding. Just fork the repository and start coding.
## Remote execution ## Remote execution
You can specify a key called `remote_topgrades` in the configuration file. You can specify a key called `remote_topgrades` in the configuration file.
This key should contain a list of hostnames that have topgrade installed on them. This key should contain a list of hostnames that have topgrade installed on them.
Topgrade will use `ssh` to run `topgrade` on remote hosts before acting locally. Topgrade will use `ssh` to run `topgrade` on remote hosts before acting locally.