From 02b19a2a78b25bd7c4630825213b8f242694e140 Mon Sep 17 00:00:00 2001 From: Louis Thiery Date: Tue, 10 Mar 2020 11:12:31 -0700 Subject: [PATCH] Add README to zip files. Add Windows notes to README (#3) --- .travis.yml | 1 + README.md | 4 ++++ 2 files changed, 5 insertions(+) diff --git a/.travis.yml b/.travis.yml index f83e813..2499929 100644 --- a/.travis.yml +++ b/.travis.yml @@ -14,6 +14,7 @@ DEPLOY_TO_GITHUB: &DEPLOY_TO_GITHUB - mkdir $name - cp target/$TARGET/release/helium-console-cli$EXE $name/ - cp LICENSE $name/ + - cp README.md $name/ - zip -r $name.zip $name deploy: provider: releases diff --git a/README.md b/README.md index f9e7495..d4990b5 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,10 @@ Download a compiled release [here](https://github.com/helium/helium-console-cli/ ## Usage +### Windows + +On Windows, the CLI requires [mingw](http://www.mingw.org/wiki/Install_MinGW) at the moment. Do a default installation for the necessary dependencies. + ### Setup First time you use the CLI, you will need to provide an API key. To create an account key, go to your [profile](https://console.helium.com/profile) on Helium Console. From the top right corner, click: Account->Profile.