From d3fa52baf1ff645d2ad883119ef33bdb1ee06eee Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Kaarlo=20R=C3=A4ih=C3=A4?= Date: Wed, 22 Jan 2020 18:42:28 +0200 Subject: [PATCH] Add requirements to README --- README.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c295713..6401d81 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,20 @@ A Cake AddIn that extends Cake with [AppCenter](https://github.com/Microsoft/app 1.0.0 Supports Cake 0.26 and .NET Standard 2.0. +## Requirements + +App Center Command Line Interface (CLI) must be installed, and Cake.AppCenter does not work without it (error will be *AppCenter: Could not locate executable.* if you try to use Cake.AppCenter without appcenter-cli). This can be done by installing [Node.js](https://nodejs.org/) first, and then by using **npm** from command-line/terminal + +``` +npm install -g appcenter-cli +``` + +or run with sudo if you get permission errors + +``` +sudo npm install -g appcenter-cli +``` + ## Including addin Including addin in cake script is easy. ``` @@ -39,4 +53,4 @@ This version is built against AppCenter CLI tools version 1.0.16. ## Credits -Brought to you by [Miha Markic](https://github.com/MihaMarkic) ([@MihaMarkic](https://twitter.com/MihaMarkic/)) and contributors. \ No newline at end of file +Brought to you by [Miha Markic](https://github.com/MihaMarkic) ([@MihaMarkic](https://twitter.com/MihaMarkic/)) and contributors.