Skip to content

Commit

Permalink
Improving user guide
Browse files Browse the repository at this point in the history
  • Loading branch information
Juan Pedro Monetta Sanchez authored and Juan Pedro Monetta Sanchez committed Aug 16, 2023
1 parent 7405bb7 commit 1375d0f
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 11 deletions.
12 changes: 7 additions & 5 deletions docs/user_guide.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -40,9 +40,11 @@ You use it by swapping the official Clojure compiler by ClojureStorm at dev time

==== ClojureStorm

This is the newest and simplest way of using FlowStorm, and requires you to swap your official Clojure compiler by ClojureStorm.
Swapping compilers sounds like a lot but don't worry, ClojureStorm is just a patch applied over the official compiler with some
extra stuff for automatic instrumentation, you shouldn't encounter any differences.
This is the newest and simplest way of using FlowStorm. It requires you to swap your official Clojure compiler by ClojureStorm only at dev time.

Swapping compilers sounds like a lot, but don't worry, ClojureStorm is just a patch applied over the official compiler with some
extra stuff for automatic instrumentation, you shouldn't encounter any differences, it is only for dev, and you can swap it back and forth by starting
your repl with a different alias or lein profile.

The easiest way to run and learn FlowStorm with ClojureStorm is by running the repl tutorial, like this :

Expand All @@ -65,9 +67,9 @@ It is much safer to just write the latest versions. Check out the https://githu


Pasting that command on your terminal will bring up a repl with FlowStorm and the compiler swapped by ClojureStorm. When the repl comes up just
evaluate the `:tut/basics` keyword on it for a tour of what it can do.
evaluate the `:tut/basics` keyword on it for a tour of the basics.

After the tutorial you would want to add it and configure it for your project, so here are the basics :
After the tutorial you would want to add and configure it for your projects, so here are the basics :

If your project is using deps.edn, your deps.edn file should look like this :
[,clojure]
Expand Down
18 changes: 12 additions & 6 deletions docs/user_guide.html
Original file line number Diff line number Diff line change
Expand Up @@ -837,9 +837,12 @@ <h4 id="_clojure"><a class="anchor" href="#_clojure"></a><a class="link" href="#
<div class="sect4">
<h5 id="_clojurestorm"><a class="anchor" href="#_clojurestorm"></a><a class="link" href="#_clojurestorm">ClojureStorm</a></h5>
<div class="paragraph">
<p>This is the newest and simplest way of using FlowStorm, and requires you to swap your official Clojure compiler by ClojureStorm.
Swapping compilers sounds like a lot but don&#8217;t worry, ClojureStorm is just a patch applied over the official compiler with some
extra stuff for automatic instrumentation, you shouldn&#8217;t encounter any differences.</p>
<p>This is the newest and simplest way of using FlowStorm. It requires you to swap your official Clojure compiler by ClojureStorm only at dev time.</p>
</div>
<div class="paragraph">
<p>Swapping compilers sounds like a lot, but don&#8217;t worry, ClojureStorm is just a patch applied over the official compiler with some
extra stuff for automatic instrumentation, you shouldn&#8217;t encounter any differences, it is only for dev, and you can swap it back and forth by starting
your repl with a different alias or lein profile.</p>
</div>
<div class="paragraph">
<p>The easiest way to run and learn FlowStorm with ClojureStorm is by running the repl tutorial, like this :</p>
Expand Down Expand Up @@ -872,10 +875,10 @@ <h5 id="_clojurestorm"><a class="anchor" href="#_clojurestorm"></a><a class="lin
</div>
<div class="paragraph">
<p>Pasting that command on your terminal will bring up a repl with FlowStorm and the compiler swapped by ClojureStorm. When the repl comes up just
evaluate the <code>:tut/basics</code> keyword on it for a tour of what it can do.</p>
evaluate the <code>:tut/basics</code> keyword on it for a tour of the basics.</p>
</div>
<div class="paragraph">
<p>After the tutorial you would want to add it and configure it for your project, so here are the basics :</p>
<p>After the tutorial you would want to add and configure it for your projects, so here are the basics :</p>
</div>
<div class="paragraph">
<p>If your project is using deps.edn, your deps.edn file should look like this :</p>
Expand Down Expand Up @@ -2350,6 +2353,9 @@ <h3 id="_the_tool_bar"><a class="anchor" href="#_the_tool_bar"></a><a class="lin
<li>
<p>Start/Stop recording. You can keep code instrumented but keep your heap from growing by stopping recording when you are not debugging.</p>
</li>
<li>
<p>Unblock all breakpoint blocked threads if any.</p>
</li>
</ul>
</div>
</div>
Expand Down Expand Up @@ -2872,7 +2878,7 @@ <h3 id="_internals_diagrams_and_documentation"><a class="anchor" href="#_interna
</div>
<div id="footer">
<div id="footer-text">
Last updated 2023-08-16 10:03:49 -0300
Last updated 2023-08-16 15:39:21 -0300
</div>
</div>
</body>
Expand Down

0 comments on commit 1375d0f

Please sign in to comment.