This file is git-ignored (not persistent in the Git repository), which means that Readium's default configuration is never at risk of being mistakenly overridden by developers, whilst giving developers the possibility of creating custom builds. Normally, developers can override the default plugins configuration by using an additional file called plugins-override.cson. When invoking the npm run build command, the build-output folder contains RequireJS module bundles that include the default plugins specified in plugins/plugins.cson (see the PLUGINS.md documentation).

npm run http (same as above, but without watching for file changes (no automatic rebuild)).

npm run http:watch (to launch an http server with live-reload, automatically opens a web browser instance to the HTML files in the dev folder).

npm run build (to update the RequireJS bundles in the build output folder).

Hack away! (mostly the source code in the js and plugins folders).

npm update (to make sure that the dependency tree is up to date).note that the -production option can be used to avoid downloading development dependencies, for example when testing only the pre-built build-output folder contents) npm install (to download dependencies defined in package.json.

Note that the above command executes the following: Should this be the case, running sudo npm run prepare:all usually solves this. Note that in some cases, administrator rights may be needed in order to install dependencies, because of NPM-related file access permissions (the console log would clearly show the error). OR: yarn run prepare:yarn:all (to use Yarn instead of NPM for node_module management).npm run prepare:all (to perform required preliminary tasks, like patching code before building).git checkout BRANCH_NAME & git submodule foreach -recursive 'git checkout BRANCH_NAME' to switch to the desired BRANCH_NAME.git submodule update -init -recursive to ensure that the readium-shared-js chain of dependencies is initialised (readium-cfi-js).NodeJS ( ) v4+ (Note that NodeJS v6+ and NPM v3+ are now supported, including NodeJS v7+ and NPM v4+).On Windows, GitShell works great ( ), GitBash works too ( ), and Cygwin adds useful commands ( ). Chrome extension (can be used offline):.This is a software component commonly-shared between the Readium Chrome extension and 'cloud reader' ( ),Īs well as various native application 'launchers' such as iOS ( ), EPUB rendering engine written in HTML, CSS and Javascript.

Readium chrome