From 56824171039b6260767390d9ffff81761b4d67bb Mon Sep 17 00:00:00 2001 From: Mike Arpaia Date: Wed, 21 Sep 2016 17:40:26 -0700 Subject: [PATCH] Cleaning up some documentation and comments (#221) --- Makefile | 3 +++ README.md | 9 ++++----- 2 files changed, 7 insertions(+), 5 deletions(-) diff --git a/Makefile b/Makefile index 929efc700..e72f4bf95 100644 --- a/Makefile +++ b/Makefile @@ -103,6 +103,9 @@ generate: .prefix -o=server/bindata.go \ frontend/templates/ assets/... +# we first generate the webpack bundle so that bindata knows to watch the +# output bundle file. then, generate debug bindata source file. finally, we +# run webpack in watch mode to continuously re-generate the bundle generate-dev: .prefix webpack --progress --colors go-bindata -debug -pkg=server \ diff --git a/README.md b/README.md index 6a47e3eb6..b2fc99c48 100644 --- a/README.md +++ b/README.md @@ -41,9 +41,9 @@ minimum toolset: * [Docker](https://www.docker.com/products/overview#/install_the_platform) -If you're using MacOS or Linux, you should have Make installed already. If you +If you're using MacOS or Linux, Make should be installed by default. If you are using Windows, you will need to install it separately. Additionally, if you -would only like to run an in-memory instances of Kolide (for demonstrations, +would only like to run an in-memory instance of Kolide (for demonstrations, testing, etc.), then you do not need to install Docker. Once you have those minimum requirements, you will need to install Kolide's @@ -53,9 +53,8 @@ dependent libraries. To do this, run the following: make deps ``` -When pulling in new revisions to the Kolide codebase to your working source -tree, it may be necessary to re-run `make deps` if a new Go or JavaScript -dependency was added. +When pulling in new revisions to your working source tree, it may be necessary +to re-run `make deps` if a new Go or JavaScript dependency was added. ### Building