Skip to content

Commit

Permalink
Fix #29 update readme for windows support
Browse files Browse the repository at this point in the history
  • Loading branch information
innobead committed Feb 21, 2021
1 parent 91e0037 commit 2b3e23d
Show file tree
Hide file tree
Showing 6 changed files with 84 additions and 25 deletions.
89 changes: 69 additions & 20 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,12 @@
- Manages the default package repository with an awesome package list including popular star github projects (ex: K8s, K3s, cloud-native, etc)
- Supports `huber.yaml` in any public/private github repo aware to Huber to manage the described packages
- Supports secure protocols (`SSH`/`HTTPS`) for github communication
- Supports cross platforms (Linux x86_64/amd64, Linux arm64/aarch64, MacOS x86_64/amd64, Windows x86_64/amd64)
- Supports cross platforms
- Linux x86_64/amd64
- Linux arm64/aarch64
- Linux arm-v7
- MacOS x86_64/amd64
- Windows x86_64/amd64

![huber in action](./doc/demo.svg)

Expand Down Expand Up @@ -40,6 +45,7 @@ or run `make setup-dev` or `hack/setup-dev.sh` to set up the development environ
### Windows

Please make sure install [libarchive](https://www.libarchive.org/) on your system, which is supported in Cygwin, MinGW (`pacman -S mingw-w64-x86_64-libarchive`) and Visual Studio (via `vcpkg install libarchive`).
For vcpkg, you can refer to [vcpkg#quick-start-windows](https://github.com/microsoft/vcpkg#quick-start-windows)

## Installing Huber

Expand All @@ -49,8 +55,12 @@ For official releases, please install the latest release as below command. After
But, if it does not work as expected, please remember to add `$HOME/.huber/bin` in the environment path, so `huber` will be looked up correctly.

```console
# Linux
curl -sfSL https://raw.githubusercontent.com/innobead/huber/master/hack/install.sh | bash

# Windows
. { iwr -useb https://raw.githubusercontent.com/innobead/huber/master/hack/windows/install.ps1 } | iex; install

# Update the environment path if required
echo "export PATH=\$HOME/.huber/bin:\$PATH" >> ~/.bashrc
```
Expand Down
2 changes: 1 addition & 1 deletion src/app/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "huber"
version = "0.2.5"
version = "0.2.6"
description = "Huber package, simplify `GitHub release` package management with a live awesome list of GitHub project"
authors = ["David Ko <[email protected]>"]
edition = "2018"
Expand Down
2 changes: 1 addition & 1 deletion src/common/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "huber-common"
version = "0.2.5"
version = "0.2.6"
authors = ["David Ko <[email protected]>"]
edition = "2018"

Expand Down
2 changes: 1 addition & 1 deletion src/generator/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "huber-generator"
version = "0.2.5"
version = "0.2.6"
authors = ["David Ko <[email protected]>"]
edition = "2018"
build = "src/build.rs"
Expand Down
2 changes: 1 addition & 1 deletion src/procmacro/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "huber-procmacro"
version = "0.2.5"
version = "0.2.6"
authors = ["David Ko <[email protected]>"]
edition = "2018"

Expand Down

0 comments on commit 2b3e23d

Please sign in to comment.