exlim/cyberchef
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updated Getting started (markdown)

n1474335 2019-10-16 16:39:26 +01:00
parent 810652bca1
commit 4a7c9e0cc2
1 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
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. 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 ## 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: Grunt has been configured with several tasks to aid in the development process: