add more metadata and installation options
All checks were successful
Rust / build (push) Successful in 1m58s
All checks were successful
Rust / build (push) Successful in 1m58s
This commit is contained in:
parent
cce94deba1
commit
30b887dc03
|
@ -1,8 +1,16 @@
|
|||
[package]
|
||||
name = "servicepoint-cli"
|
||||
description = "A command line interface for the ServicePoint display."
|
||||
version = "0.1.0"
|
||||
edition = "2021"
|
||||
rust-version = "1.78.0"
|
||||
publish = true
|
||||
resolver = "2"
|
||||
readme = "README.md"
|
||||
license = "GPL-3.0-or-later"
|
||||
repository = "https://git.berlin.ccc.de/servicepoint/servicepoint-cli"
|
||||
homepage = "https://crates.io/crates/servicepoint-cli"
|
||||
keywords = ["cccb", "cccb-servicepoint", "cli"]
|
||||
|
||||
[dependencies]
|
||||
servicepoint = { version = "0.13.0", features = ["protocol_websocket"] }
|
||||
|
|
20
README.md
20
README.md
|
@ -4,16 +4,15 @@ This repository contains a command line interface for the ServicePoint display.
|
|||
|
||||
To send commands, this uses the [servicepoint crate](https://crates.io/crates/servicepoint).
|
||||
|
||||
## Running
|
||||
## Installation with cargo
|
||||
|
||||
Any OS:
|
||||
```shell
|
||||
git clone https://git.berlin.ccc.de/servicepoint/servicepoint-cli.git
|
||||
cd servicepoint-cli
|
||||
cargo run -- <args>
|
||||
cargo install servicepoint-cli
|
||||
```
|
||||
|
||||
Using nix:
|
||||
If you have set your PATH to include the ~/.cargo/bin, you can now run `servicepoint-cli`.
|
||||
|
||||
## Running with nix
|
||||
|
||||
```shell
|
||||
# from CCCB Forgejo
|
||||
|
@ -23,6 +22,15 @@ nix run git+https://git.berlin.ccc.de/servicepoint/servicepoint-cli.git -- <args
|
|||
nix run github:kaesaecracker/servicepoint-cli -- <args>
|
||||
```
|
||||
|
||||
|
||||
## Running a debug build
|
||||
|
||||
```shell
|
||||
git clone https://git.berlin.ccc.de/servicepoint/servicepoint-cli.git
|
||||
cd servicepoint-cli
|
||||
cargo run -- <args>
|
||||
```
|
||||
|
||||
## Contributing
|
||||
|
||||
If you have ideas on how to improve the code, add features or improve documentation feel free to open a pull request.
|
||||
|
|
Loading…
Reference in a new issue