From 4a7c9e0cc27069c5d56f96aac22cfe4b389931bb Mon Sep 17 00:00:00 2001 From: n1474335 Date: Wed, 16 Oct 2019 16:39:26 +0100 Subject: [PATCH] Updated Getting started (markdown) --- Getting-started.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/Getting-started.md b/Getting-started.md index 7ea8b03..5f45215 100644 --- a/Getting-started.md +++ b/Getting-started.md @@ -11,11 +11,13 @@ CyberChef uses the Grunt build system, so it's very easy to install. You'll need npm will then install all the dependencies needed by Grunt. -_Consider adding `export NODE_OPTIONS=--max_old_space_size=2048` to your `~/.bashrc` file. If you attempt to build a production version of CyberChef, you may get a "JavaScript heap out of memory" error if you do not set this environment variable._ +> Consider adding `export NODE_OPTIONS=--max_old_space_size=2048` to your `~/.bashrc` file. If you attempt to build a production version of CyberChef, you may get a "JavaScript heap out of memory" error if you do not set this environment variable. ## Compiling +> Note that CyberChef only supports bash-based dev environments, so primarily Linux and Mac. You may be able to get a build working on Windows, but it is not officially supported. + Grunt has been configured with several tasks to aid in the development process: