From 5a44165e2b018b75a5c26b1e687197b72d23070c Mon Sep 17 00:00:00 2001 From: "chris (daiyi)" Date: Tue, 25 Jul 2017 15:44:35 +0200 Subject: [PATCH] Edit installation instructions --- README.md | 66 ++++++++++++++++++++++++++++++++----------------------- 1 file changed, 38 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index 06ae4e6..633907f 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # re-frame-trace -A trace window for re-frame +A trace panel for re-frame. ## Motivation @@ -8,41 +8,51 @@ re-frame provides a data driven architecture, but we need to be able to inspect +## Installation + +If you are using leiningen, modify `project.clj` in the following ways. When puzzling over the various possible leiningen configurations, it's often helpful to look at a sample [project.clj](https://github.com/technomancy/leiningen/blob/stable/sample.project.clj). + +- Add re-frame-trace as a dev dependency by placing `[day8.re-frame/trace "0.1.0"]` within `:profiles :dev :dependencies`. For example: + + ```cljs + :profiles + {:dev + {:dependencies [[some-other-package "0.0.0"] + [day8.re-frame/trace "0.1.0"]] }} + ``` + +- Locate the `:compiler` map under `:dev` and add: + + - `:closure-defines {"re_frame.trace.trace_enabled_QMARK_" true}` + - `:preloads [day8.re-frame.trace.preload]` + + For example: + + ```cljs + {:builds + [{:id "dev" + :source-paths ["src" "dev"] + :compiler {... + :closure-defines {"re_frame.trace.trace_enabled_QMARK_" true} + :preloads [day8.re-frame.trace.preload]}}]} + ``` + +## Usage + +- Start up your application. + +- Once it is loaded, focus the document window and press `ctrl-h` to slide open the trace panel and enable tracing. + +- When the panel is closed, tracing is disabled. + ## How does it work? re-frame has instrumentation to collect traces throughout various important points in the lifecycle of a re-frame app. re-frame-trace is a consumer of these traces, and provides visualisations of the traces. These traces have a well-defined structure, and will eventually be standardised, allowing other developers to create their own tooling to work against the traces. Currently, re-frame's tracing and re-frame-trace are in alpha and are subject to change at any time. -## Getting started - -Compile your app with `:closure-defines: "re_frame.trace.trace_enabled_QMARK_" true` and `:preloads [day8.re-frame.trace.preload]`. - -So when using leiningen, add the following to `project.clj`: - -- `[day8.re-frame/trace "0.1.0"]` in `:profiles :dev :dependencies` - - ```cljs - {:profiles - {:dev - {:dependencies [day8.re-frame/trace "0.1.0"] }} - ``` -- `:closure-defines: "re_frame.trace.trace_enabled_QMARK_" true` and `:preloads [day8.re-frame.trace.preload]` in `:compiler` - - ```cljs - {:builds - [{:id "dev" - :source-paths ["src" "dev"] - :compiler {... - :closure-defines {"re_frame.trace.trace_enabled_QMARK_" true} - :preloads [day8.re-frame.trace.preload]}}]} - ``` - By default, re-frame tracing is compiled out, so it won't impose a performance cost in production. The trade-off here is that you need to explicitly enable it in development. The [preloads](https://github.com/clojure/clojurescript/wiki/Compiler-Options#preloads) option (`:preloads [day8.re-frame.trace.preload]`) has to be set in order to automatically monkeypatch Reagent to add appropriate lifecycle hooks. Yes this is gross, and yes we will try and make a PR to reagent to add proper hooks, once we know exactly what we need. The preload namespace also injects a div containing the devtools panel into the DOM. -Now you can start up your application. Once it is loaded, press Ctrl+H to slide open the trace panel and enable tracing. When the panel is closed, tracing is disabled. - - ## Development ### Setting up re-frame-trace for development