mirror of
https://github.com/tribufu/rust-gamedig
synced 2026-06-01 09:42:41 +00:00
[Crate] Add documentation for where versions need to be updated (#58)
VERSIONS.md tells you what the current versions for things like MSRV is and which files you need to update if you change it. Also fixes the incorrect: - MSRV in README.md - nightly version in .pre-commit-config.yaml
This commit is contained in:
parent
9c93e40650
commit
bf14ecb4a4
3 changed files with 29 additions and 3 deletions
|
|
@ -8,10 +8,10 @@ repos:
|
||||||
language: system
|
language: system
|
||||||
files: '[.]rs$'
|
files: '[.]rs$'
|
||||||
pass_filenames: false
|
pass_filenames: false
|
||||||
entry: rustup run --install nightly cargo-clippy -- -- -D warnings
|
entry: rustup run --install nightly-2023-03-01 cargo-clippy -- -- -D warnings
|
||||||
- id: format
|
- id: format
|
||||||
name: Check rustfmt
|
name: Check rustfmt
|
||||||
language: system
|
language: system
|
||||||
files: '[.]rs$'
|
files: '[.]rs$'
|
||||||
pass_filenames: false
|
pass_filenames: false
|
||||||
entry: rustup run --install nightly cargo-fmt --check
|
entry: rustup run --install nightly-2023-03-01 cargo-fmt --check
|
||||||
|
|
|
||||||
|
|
@ -11,7 +11,7 @@ within the library or want to request a feature, it's better to do so here rathe
|
||||||
on Discord.
|
on Discord.
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
Minimum Supported Rust Version is `1.56.1` and the code is cross-platform.
|
Minimum Supported Rust Version is `1.60.0` and the code is cross-platform.
|
||||||
|
|
||||||
Pick a game/service/protocol (check the [GAMES](GAMES.md), [SERVICES](SERVICES.md) and [PROTOCOLS](PROTOCOLS.md) files to see the currently supported ones), provide the ip and the port (be aware that some game servers use a separate port for the info queries, the port can also be optional if the server is running the default ports) then query on it.
|
Pick a game/service/protocol (check the [GAMES](GAMES.md), [SERVICES](SERVICES.md) and [PROTOCOLS](PROTOCOLS.md) files to see the currently supported ones), provide the ip and the port (be aware that some game servers use a separate port for the info queries, the port can also be optional if the server is running the default ports) then query on it.
|
||||||
|
|
||||||
|
|
|
||||||
26
VERSIONS.md
Normal file
26
VERSIONS.md
Normal file
|
|
@ -0,0 +1,26 @@
|
||||||
|
# MSRV (Minimum Supported Rust Version)
|
||||||
|
|
||||||
|
Current: `1.60.0`
|
||||||
|
|
||||||
|
Places to update:
|
||||||
|
- `Cargo.toml`
|
||||||
|
- `README.md`
|
||||||
|
- `.github/workflows/ci.yml`
|
||||||
|
|
||||||
|
# rustfmt version
|
||||||
|
|
||||||
|
Current: `1.5.2`
|
||||||
|
|
||||||
|
Places to update:
|
||||||
|
- `.rustfmt.toml`
|
||||||
|
- The nightly rust version
|
||||||
|
|
||||||
|
# The nightly rust version
|
||||||
|
|
||||||
|
The toolchain version used to run rustfmt in CI
|
||||||
|
|
||||||
|
Current: `nightly-2023-03-01`
|
||||||
|
|
||||||
|
Places to update:
|
||||||
|
- `./.github/workflows/ci.yml`
|
||||||
|
- `./.pre-commit-config.yaml`
|
||||||
Loading…
Add table
Add a link
Reference in a new issue