From 799178a16f875904c61a15b447d2026c0ba8ae69 Mon Sep 17 00:00:00 2001 From: Rob Garrison Date: Mon, 13 Aug 2018 10:50:34 -0500 Subject: [PATCH] Add information about the build zip process --- vendor/README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/vendor/README.md b/vendor/README.md index 8a8b7dc3..fc0b6e78 100644 --- a/vendor/README.md +++ b/vendor/README.md @@ -24,3 +24,16 @@ The following changes are made: * `lz-string-unsafe`: The compressed `lz-string-unsafe.min.js` file is copied directly into `vendor/lz-string-unsafe`. * `semver-bundle`: The `dist/semver.js` file is copied directly into `vendor/semver`. * `stylus-lang-bundle`: The `stylus.min.js` file is copied directly into `vendor/stylus-lang-bundle`. + +## Creating the ZIP + +Use `npm run zip`. + +This command creates a zip file that includes all the files from the repository **except**: + +* All dot files (e.g. `.eslintrc` & `.gitignore`). +* `node_modules` folder. +* `tools` folder. +* `package.json` file. +* `package-lock.json` and/or `yarn.lock` file(s). +* `vendor/codemirror/lib` files. This path is excluded because it contains a file modified for development purposes only. Instead, the CodeMirror files are copied directly from `node_modules/codemirror/lib`.