Add README to zip files. Add Windows notes to README (#3)

helium · Mar 10, 2020 · 02b19a2 · 02b19a2
1 parent eded022
commit 02b19a2
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 0 deletions.
diff --git 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
@@ -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.