Added Documentation for Standalone Client. (#136)

* Added Documentation for Standalone Client. * Updated Link and Names for Standalone Client. * Updated Link in README * Update README.md Updated link * Update Getting-Started.org updated name for brunt --------- Co-authored-by: Tom Hanika <[email protected]>
tomhanika · Jan 10, 2025 · 188a369 · 188a369
1 parent 0f45451
commit 188a369
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -12,6 +12,7 @@ much more.
 2. Don't Bother Me with Theory, I Want to Do Stuff! (aka: Tutorials)
    1. [A Gentle Introduction](doc/tutorials/icfca-2013/icfca2013-tutorial-live.org) (ICFCA 2013)
    2. [Compute the Canonical Base from a Formal Context that is given in CSV Format](doc/tutorials/How-to-compute-the-Canonical-Base-from-a-Context-given-in-CSV-Format.org)
+   3. [Standalone Console Application](https://github.com/tomhanika/brunt)
 3. A more complete overview over `conexp-clj`
    1. [Notation and Syntax](doc/Basic-Notation-and-Syntax.org)
    2. [Creating and Working with Formal Contexts](doc/Formal-Contexts.org)

diff --git a/doc/Getting-Started.org b/doc/Getting-Started.org
@@ -222,3 +222,24 @@ conexp.fca.implications/parallel-canonical-base-from-clop
   predicate.
 nil
 #+end_src
+
+** Console Client
+
+~brunt~ is a standalone console application that supports some ~conexp-clj~ functions and can conveniently be run from the command line.
+It can be downloaded here:	[[https://github.com/tomhanika/brunt]]
+
+Functions can be executed like this:
+
+#+begin_src clojure :results silent
+$ java -jar builds/uberjar/brunt-0.1.0.jar -f draw-concept-lattice testing-data/living-beings-and-water.ctx
+#+end_src
+
+For an overview of all supported functions and their parameters run:
+#+begin_src clojure :results silent
+$ java -jar brunt-0.1.0.jar -h
+#+end_src
+
+The ~brunt~ repository provides a detailed documentation.
+
+
+