Update docs for using Garden

This commit is contained in:
Daniel Compton 2017-11-24 16:24:46 +13:00
parent 590343b36d
commit 132dcd6b02
4 changed files with 6 additions and 29 deletions

View File

@ -3,6 +3,10 @@ All notable changes to this project will be documented in this file. This change
## [Unreleased] ## [Unreleased]
### Changed
* Switched from LESS to Garden styles. Now interactive development and debugging of re-frame-trace is even faster.
## [0.1.13] - 2017-11-23 ## [0.1.13] - 2017-11-23
**N.B.** To make the best use of the new subscriptions panel, you also need to update to re-frame v0.10.3-alpha1. **N.B.** To make the best use of the new subscriptions panel, you also need to update to re-frame v0.10.3-alpha1.

View File

@ -39,39 +39,15 @@ You need both the re-frame-trace project _and_ a test project to develop it agai
- Now run your test project however you usually run it, and re-frame-trace should be in there. \o/ - Now run your test project however you usually run it, and re-frame-trace should be in there. \o/
- Additionally, if modifying the `.less` CSS files, compile the css by running within the re-frame-trace directory:
```
lein less auto
```
to watch for changes, or one time by running:
```
lein less once
```
And then any time you want to reload the CSS, you have to **manually save/touch `styles.cljs`**. Figwheel will not do it for you. ([See below](#problems-while-developing-css) for details).
### Developing CSS ### Developing CSS
The styles for the trace panel are defined both inline and in a LESS file. To develop the styles, edit `resources/day8/re_frame/trace/main.less` and run The styles for the trace panel are defined both inline and in Garden styles in `day8.re-frame.trace.styles`.
``` We are using CSS preprocessing to isolate the panel styles, by namespacing the panel styles with the id `#--re-frame-trace--`.
lein less auto
```
to watch the LESS file and automatically recompile on changes.
**Don't edit the CSS file `resources/day8/re_frame/trace/main.css` directly**, as it will be overwritten.
We are using CSS preprocessing because in order to isolate the panel styles, we are namespacing the panel styles with the id `#--re-frame-trace--`.
#### Problems while developing CSS #### Problems while developing CSS
- You must touch or save the `styles.cljs` file to trigger a CSS reload if you're editing `main.less`. This is because `styles.cljs` slurps `main.css` with a macro that happens before Clojurescript compilation, so figwheel isn't aware of the changes.
- Did you run `lein less auto` or `lein less once` to compile LESS to CSS?
- Try clearing your browser cache/hard-reloading. - Try clearing your browser cache/hard-reloading.
### Updating the internal version of re-frame used ### Updating the internal version of re-frame used

View File

@ -18,7 +18,6 @@
:release-tasks [["vcs" "assert-committed"] :release-tasks [["vcs" "assert-committed"]
["change" "version" "leiningen.release/bump-version" "release"] ["change" "version" "leiningen.release/bump-version" "release"]
["less" "once"]
["vcs" "commit"] ["vcs" "commit"]
["vcs" "tag"] ["vcs" "tag"]
["deploy"] ["deploy"]

View File

@ -319,8 +319,6 @@
(def panel-styles (apply garden/css [css-reset re-frame-trace-styles])) (def panel-styles (apply garden/css [css-reset re-frame-trace-styles]))
(js/console.log panel-styles)
;(def panel-styles (macros/slurp-macro "day8/re_frame/trace/main.css")) ;(def panel-styles (macros/slurp-macro "day8/re_frame/trace/main.css"))