jdormit/looped-in
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update documentation to explain Figwheel support

Browse Source
This commit is contained in:
Jeremy Dormitzer 2018-02-16 12:05:02 -05:00
parent c144fc17d5
commit 1f02f207d9
No known key found for this signature in database
GPG Key ID: 04F17C0F5A32C320
2 changed files with 10 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
CHANGELOG.md
View File

@ -4,6 +4,7 @@ All notable changes to this project will be documented in this file. This change
## [Unreleased]
### Changed
- Refactored the directory structure and build process to enable separate development and production resources.
- Enabled [Figwheel](https://github.com/bhauman/lein-figwheel) support for the development build.
## [1.1.2]
### Changed

12
README.md
View File

@ -13,11 +13,17 @@ To obtain a copy of the source code:
$ git clone git@github.com:jdormit/looped-in.git
To build the source code once, navigate to the project root and run:
To build the source code, navigate to the project root and run:
$ make clean dev
$ make dev
This will output the development build of the compiled extension to `ext`. The development build produces source maps and is significantly faster to compile. If you want a production build, run `make clean prod` instead.
This will output a development build of the extension to `ext`. Additionally, it will start a [Figwheel](https://github.com/bhauman/lein-figwheel) session for the background and sidebar scripts, enabling live reloading and connecting a Clojurescript REPL to the sidebar script. Due to strict content security policy for content scripts, Figwheel cannot be enabled for the content script.
If you want a production build instead, run:
$ make prod
This will output an optimized production build of the extension to `ext`. The production build does not feature live reloading. It also takes significantly longer than the development build.
To load the extension locally in your browser, see [instructions for Firefox](https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Temporary_Installation_in_Firefox) or [instructions for Chrome](https://developer.chrome.com/extensions/getstarted#unpacked).