Skip to content

Commit

Permalink
Update readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
svenrademakers committed Aug 16, 2023
1 parent 6a2b751 commit 5b9c9fd
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 11 deletions.
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name = "tpi"
version = "0.1.0"
edition = "2021"
license = "Apache-2.0"
authors = ["Sven Rademakers <sven.rademakers@gmail.com>"]
authors = ["Sven Rademakers <sven@turingpi.com>"]
description = "CLI tool to control a Turing-Pi board"
homepage = "https://turingpi.com/"
repository = "https://github.com/turing-machines/tpi"
Expand Down
21 changes: 11 additions & 10 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,16 @@
# Tpi cli
# Tpi Command

Host tool to interface with your turing-pi board
Tool to control your Turing-Pi board. It will use a default host address to find
the board on the network (`turingpi.local`). Pass `-host <your-hostname/ip>` to
change the default host address. For more information on usage, execute the help
command: `tpi --help`

## Install

### Github CI
### GitHub CI

Packages for windows, linux and Apple are being build on the master branch. Take
a look at the artifacts of a workflow run to download these packages :
The `master` branch builds Windows, Linux, and Apple packages on every commit.
Take a look at the artifacts of a workflow run to download these packages :
https://github.com/turing-machines/tpi/actions/workflows/build.yml

### AUR
Expand All @@ -18,10 +21,8 @@ This package is available in the AUR repository.

### Cargo

Latest master can be installed using the following cargo command
Install the latest master using the following cargo command.

```shell
cargo install --git https://github.com/turing-machines/tpi --branch master
``` shell
cargo install --git https://github.com/turing-machines/tpi --branch
```


0 comments on commit 5b9c9fd

Please sign in to comment.