Merge branch 'main' of github.com:bencardoen/SubPrecisionContactDetec…

…tion.jl
bencardoen · Oct 30, 2024 · 64672ba · 64672ba
2 parents 2f8e98d + ed9de56
commit 64672ba
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 1 deletion.
diff --git a/docs/src/index.md b/docs/src/index.md
@@ -1,6 +1,7 @@
 # SubPrecisionContactDetection.jl Documentation
 
 Welcome to the documentation for this package.
+This holds the implementation for [MCS-DETECT, published in JCB](https://doi.org/10.1083/jcb.202206109).
 Please see the sidebar for relevant sections.
 
 This package offers variable distance contact detection between two images (2/3D) when segmentation is not sufficiently accurate. 

diff --git a/docs/src/tutorial.md b/docs/src/tutorial.md
@@ -48,11 +48,19 @@ For example:
 
 ![example](./assets/interactive.png)
 
+This would work like this:
+
+```julia
+using Pkg; Pkg.activate("."); # <CTRL+ENTER>
+using SubPrecisionContactDetection; # <CTRL+ENTER>
+@info "Test"; #CTRL+ENTER
+defs = get_defaults(); #CTRL+ENTER
+```
 
 ## Julia API
 While you can call the scripts from the command line, you can also do so from within Julia:
 
 ```julia
 using SubPrecisionInteractionDetection
 twochannel_contats(get_defaults());
-```
+```