diff --git a/README.md b/README.md index 6e5e094..06ae4e6 100644 --- a/README.md +++ b/README.md @@ -43,18 +43,43 @@ The [preloads](https://github.com/clojure/clojurescript/wiki/Compiler-Options#pr 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 +## Development -### setting up re-frame-trace for development +### Setting up re-frame-trace for development + +You need both the re-frame-trace project _and_ a test project to develop it against. For example, you can use the [todo-mvc](https://github.com/Day8/re-frame/tree/master/examples/todomvc) project. + +- Clone `re-frame-trace` to your machine: + + ``` + git clone git@github.com:Day8/re-frame-trace.git + ``` + +- Go into the root folder of the test project you're using to develop re-frame-trace with. + + ``` + cd /your/project/folder + ``` + +- Add re-frame-trace into this test project using the [instructions](#getting-started) above. + +- Still in the test project, create a folder called `checkouts`, then enter the folder: -- Clone `re-frame-trace` to your machine. -- Go into the root directory of a project you'd like to use as a host to test re-frame-trace with. For example, you can use the [todo-mvc](https://github.com/Day8/re-frame/tree/master/examples/todomvc) project. -- Add re-frame-trace into this project using the [instructions](#getting-started) above. -- Create a folder called `checkouts:` ``` mkdir checkouts + cd checkouts ``` -- Create a symlink from your local re-frame-trace project in the checkouts folder: + +- Create a [relative symlink](https://superuser.com/questions/146231/how-do-i-create-a-relative-symbolic-link-in-linux) from your local re-frame-trace project in the checkouts folder. For example: + ``` - ln -s path/to/your/local/re-frame-trace checkouts/re-frame-trace + ln -s ../relative/path/to/your/local/re-frame-trace re-frame-trace ``` + +- If you're using figwheel in the test project, you need to add the checkouts folder (`checkouts/re-frame-trace/src`) to `:cljsbuild :source-paths` in the `project.clj` file. If you're having trouble locating the right place to put this, it might help to look to a sample [project.clj](https://github.com/technomancy/leiningen/blob/stable/sample.project.clj) for inspiration. For example: + + ``` + :cljsbuild {:builds {:client {:source-paths ["checkouts/re-frame-trace/src"]}}} + ``` + +- Now run your test project however you usually run it, and re-frame-trace should be in there. \o/