From a0fd94ac06af0d8cbe39e59a26bc1bc4bedef061 Mon Sep 17 00:00:00 2001
From: Martin McKeaveney <martin@shogunsystems.co.uk>
Date: Thu, 23 Jan 2020 10:52:42 +0000
Subject: [PATCH] update readme

---
 packages/cli/readme.md  | 69 +++++++++++++++++++++++++++++++++--------
 packages/core/readme.md | 13 +-------
 readme.md               | 20 ++----------
 3 files changed, 59 insertions(+), 43 deletions(-)

diff --git a/packages/cli/readme.md b/packages/cli/readme.md
index 1c5baba626..4b7b8d187a 100644
--- a/packages/cli/readme.md
+++ b/packages/cli/readme.md
@@ -2,19 +2,11 @@
 
 (For contributors - scroll down)
 
-### 1. Prerequisites (for nodegyp)
-
-We will try to make this bit easier, but for now:
-
-- Windows  - https://github.com/nodejs/node-gyp#on-windows
-- Ubuntu `sudo apt-get install build-essentials`
-- Mac: https://github.com/nodejs/node-gyp#on-macos
-
-### 2. Global install budibase
+### 1. Global install budibase
 
 `npm install -g budibase`
 
-### 3. Start using Budibase
+### 2. Start using Budibase
 
 Create a directory to store your Budibase apps
 
@@ -42,8 +34,59 @@ Once you have created your app, you need to create yourself an instance of your
 
 `budi instance my-app`
 
-## Running the cli on dev
+## Getting Started for Contributors
+
+### 1.  Prerequisites
+
+*yarn -* `npm install -g yarn`
+
+*jest* - `npm install -g jest`
+
+### 2. Clone this repository
+
+`git clone https://github.com/Budibase/budibase.git`
+
+then `cd ` into your local copy...
+
+### 3.  Install and Build
+
+`yarn bootstrap` will install all modules
+
+`yarn build` will build all packages
+
+`yarn initialise` will initialise your budibase (i.e. create local database)
+
+### 4. Running
+
+A Budibase apps folder will have been created in `packages/server/myapps`. This is a blank apps folder, so you will need to create yourself an app:
+
+```
+cd packages/server
+yarn run budi -- new your-app-name
+```
+
+then 
+
+`yarn run budi` and to run the budibase server
+
+if you then want to run the builder in dev mode (i.e. with hot reloading):
+
+... keep the server running, and..
+1. Open a new console
+2. `cd packages/builder`
+3. `yarn start`
+4. Access the builder on http://localhost:3000
+
+Notice that when inside `packages/server`, you can use any Budibase CLI command via yarn:
+
+e.g. `yarn budi -- new mikes_app` == `budi new mikes_app`
+
+This will use the CLI directly from `packages/cli`, rather than your globally installed `budi`
+
+## Documentation
+
+A work in progress, lives here: https://docs.budibase.com
+
+
 
-If you want to test this on dev, from the mono repo, run `npm link` from here first.
 
-If you use VS Code, open it in this directory, and you will find launch configurations for each command - debugging, yay!
\ No newline at end of file
diff --git a/packages/core/readme.md b/packages/core/readme.md
index a08dc2b4f6..2d1e02970e 100644
--- a/packages/core/readme.md
+++ b/packages/core/readme.md
@@ -1,17 +1,6 @@
 ## Getting Started
 
-Install requires [node-gyp](https://github.com/nodejs/node-gyp), due to a dependancy on [argon2](https://github.com/ranisalt/node-argon2)
-
-### For node gyp on windows
-
-`npm install --global --production windows-build-tools`
-and this might help: https://github.com/nodejs/node-gyp/issues/1278
-
-### For node gyp on ubuntu
-
-`sudo apt-get install build-essentials`
-
-Once you have this, try...
+Install packages:
 
 `npm install`
 
diff --git a/readme.md b/readme.md
index 4ad650fa13..4b7b8d187a 100644
--- a/readme.md
+++ b/readme.md
@@ -2,19 +2,11 @@
 
 (For contributors - scroll down)
 
-### 1. Prerequisites (for nodegyp)
-
-We will try to make this bit easier, but for now:
-
-- Windows  - https://github.com/nodejs/node-gyp#on-windows
-- Ubuntu `sudo apt-get install build-essentials`
-- Mac: https://github.com/nodejs/node-gyp#on-macos
-
-### 2. Global install budibase
+### 1. Global install budibase
 
 `npm install -g budibase`
 
-### 3. Start using Budibase
+### 2. Start using Budibase
 
 Create a directory to store your Budibase apps
 
@@ -44,16 +36,8 @@ Once you have created your app, you need to create yourself an instance of your
 
 ## Getting Started for Contributors
 
-Install requires [node-gyp](https://github.com/nodejs/node-gyp), due to a dependancy on [argon2](https://github.com/ranisalt/node-argon2)
-
 ### 1.  Prerequisites
 
-*nodegyp -*
-
-  - Windows  - https://github.com/nodejs/node-gyp#on-windows
-  - Ubuntu `sudo apt-get install build-essentials`
-  - Mac: https://github.com/nodejs/node-gyp#on-macos
-
 *yarn -* `npm install -g yarn`
 
 *jest* - `npm install -g jest`