Update vendor/README

This commit is contained in:
Rob Garrison 2018-07-18 15:29:16 -05:00
parent 78a9c153a3
commit 6820421bef
2 changed files with 24 additions and 21 deletions

21
vendor/README vendored
View File

@ -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.<br><br>
* **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.<br><br>
* 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.

24
vendor/README.md vendored Normal file
View File

@ -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.<br><br>
* **TODO**: `node-semver` (https://github.com/eight04/node-semver-bundle) is installed.
* **TODO**: `stylus-lang` (https://github.com/eight04/stylus-lang-bundle) is installed.<br><br>
* 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`.