summaryrefslogtreecommitdiff
path: root/graphics/pgf/contrib/kblocks/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'graphics/pgf/contrib/kblocks/README.md')
-rw-r--r--graphics/pgf/contrib/kblocks/README.md14
1 files changed, 9 insertions, 5 deletions
diff --git a/graphics/pgf/contrib/kblocks/README.md b/graphics/pgf/contrib/kblocks/README.md
index ea3b8b1263..659be0e4f6 100644
--- a/graphics/pgf/contrib/kblocks/README.md
+++ b/graphics/pgf/contrib/kblocks/README.md
@@ -1,7 +1,10 @@
-This is the file README for the kblocks package, v.1.0.
+kblocks package, v.2.0.
+![kblocks example demo diagram](/intro.png)
-Description: Easily typeset Control Block Diagrams and Signal Flow Graphs with TikZ/PGF
+## Description
+A Macro Package to Easily typeset Control Block Diagrams and Signal Flow Graphs with TikZ/PGF
+## Statement of Need
Desiring to typeset control block diagrams in LaTeX and dissatisfied
with the other LaTeX macro packages that can be found online,
I thought: why not write my own macro package for this purpose.
@@ -13,19 +16,20 @@ using TikZ/ PGF more structured and easier.
This macro reduces the length of this learning curve and serves as a frontend,
by focusing the theme on control block diagrams only.
+## Getting Started
You will find a demo and an introduction in kblocks-doc.pdf file.
Fortunately this documentation in kblocks-doc.pdf as it grows and gets to be improved,
will come with a number of slowly-paced tutorials, which will guide you
on creating control block diagrams with the kblocks macro.
+## Licensing
Licensing of this package is covered by the MIT Licence.
-Any feedback is welcome: oasomefun@futa.edu.ng
+## Issues and Feedback
My wish is that you find it helpful. Don’t forget to share and like.
Please feel free to e-mail me for any improvement or suggestion with respect to
using kblocks and making it useful for researchers, students and others involved
in the applications and field of control theory.
-
-Author: Oluwasegun Somefun
+Any feedback is welcome: oasomefun@futa.edu.ng<Oluwasegun Somefun>.