diff --git a/vendor/README b/vendor/README deleted file mode 100644 index a0517e71..00000000 --- a/vendor/README +++ /dev/null @@ -1,21 +0,0 @@ -# Vendor files are populated by the build script: - -## What the build script does - -Using this repo, run `npm install`... the latest versions of: - -* `CodeMirror` (https://github.com/codemirror/CodeMirror) is installed.

-* **TODO**: `jsonlint` () is installed. -* **TODO**: `less` () is installed. -* **TODO**: `lz-string-unsafe` (https://github.com/openstyles/lz-string-unsafe) is installed. -* **TODO**: `node-semver` () is installed. -* **TODO**: `stylus-lang` () is installed.

-* The necessary build tools; see `devDependencies` in the `package.json`. - -## Running the build script - -Use `npm run build` to update packages in the `node_modules` folder & update the vendor folder. - -The following changes are made: - -* Only the essential CodeMirror files are copied directly from the `node_modules` folder to `vendor/codemirror`; see the `vendor/codemirror/README` for specifics. diff --git a/vendor/README.md b/vendor/README.md new file mode 100644 index 00000000..cb44413f --- /dev/null +++ b/vendor/README.md @@ -0,0 +1,24 @@ +# Vendor files are populated by the build script: + +## What the build script does + +Using this repo, run `npm install`... the latest versions of: + +* `CodeMirror` (https://github.com/codemirror/CodeMirror) is installed. +* `jsonlint` (https://github.com/zaach/jsonlint) is installed. +* `less` (https://github.com/less/less.js) is installed. +* `lz-string-unsafe` (https://github.com/openstyles/lz-string-unsafe) is installed.

+* **TODO**: `node-semver` (https://github.com/eight04/node-semver-bundle) is installed. +* **TODO**: `stylus-lang` (https://github.com/eight04/stylus-lang-bundle) is installed.

+* The necessary build tools are installed; see `devDependencies` in the `package.json`. + +## Running the build script + +Use `npm run build` to first update the packages in the `node_modules` folder & then update the vendor folder. + +The following changes are made: + +* `CodeMirror`: Only the essential files are copied directly from the `node_modules` folder to `vendor/codemirror`; see the `vendor/codemirror/README` for specifics. +* `jsonlint`: The uncompressed `lib/jsonlint.js` is copied directly to `vendor/jsonlint`. +* `less`: The compressed `dist/less.min.js` file is copied directly into `vendor/less`. +* `lz-string-unsafe`: The compressed `lz-string-unsafe.min.js` file is copied directly into `vendor/lz-string-unsafe`.