From 8d8fc82255604a849da02504b7cbeb1c4636d325 Mon Sep 17 00:00:00 2001 From: Nadeem Shabir Date: Tue, 18 Aug 2020 12:43:17 +0100 Subject: [PATCH] Adds an .nvmrc file fixed to 14.2 Adds more explicit instructions --- .nvmrc | 1 + README.md | 18 +++++++++++------- 2 files changed, 12 insertions(+), 7 deletions(-) create mode 100644 .nvmrc diff --git a/.nvmrc b/.nvmrc new file mode 100644 index 0000000..6b5bab0 --- /dev/null +++ b/.nvmrc @@ -0,0 +1 @@ +14.2 diff --git a/README.md b/README.md index 26db4b7..d34bfa1 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,9 @@ Talis Aspire Reading Lists Bookmarking Extension ================================================ Requirements: -- [npm](https://www.npmjs.com/) +- [nvm](https://github.com/nvm-sh/nvm) -This project provides an alternative to the Talis Aspire Reading Lists Bookmarking Bookmarklet, +This project provides an alternative to the Talis Aspire Reading Lists Bookmarking Bookmarklet, which can be forked and rebranded for distribution in institutional enterprise environments. The extension should work with: @@ -38,13 +38,17 @@ The different sizes will be used by different browsers in different ways. All strings in the extension can be edited by changing the values in the language files in the `_locales` directory. -To build the files for the extension, -``` +To build the files for the extension, +```bash +$ git checkout https://github.com/talis/rl-bookmarking-extension.git +$ cd rl-bookmarking-extension +# use nvm to switch to the version of nodejs that is required +$ nvm use $ npm install # This should also run bower install # replace ./images/*.png and ./_locales with institutional preferences -$ grunt # This will build a Chrome/Opera/Vivaldi extension -$ grunt dist-manifold # This will build a [Manifoldjs](https://github.com/pwa-builder/ManifoldJS) compatible manifest, which can be used to package an MS Edge extension -$ grunt --identifier="{AMO UUID}" # This will build the extension with a Mozilla Add-on Identifier +$ $(npm bin)/grunt # This will build a Chrome/Opera/Vivaldi extension +$ $(npm bin)/grunt dist-manifold # This will build a [Manifoldjs](https://github.com/pwa-builder/ManifoldJS) compatible manifest, which can be used to package an MS Edge extension +$ $(npm bin)/grunt --identifier="{AMO UUID}" # This will build the extension with a Mozilla Add-on Identifier ``` The `./dist` directory should then contain everything you need for a `.crx`, `.xpi`, `.zip`, etc.