Skip to content

Commit

Permalink
Updating README and USAGE with 3.3.0
Browse files Browse the repository at this point in the history
  • Loading branch information
kigster committed May 7, 2024
1 parent 8917e4e commit f7641b3
Show file tree
Hide file tree
Showing 4 changed files with 52 additions and 695 deletions.
24 changes: 12 additions & 12 deletions README.adoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[separator=—]
= Bashmatic® — BASH-based DSL helpers for humans, sysadmins, and fun.
// vim: ft=asciidoc
:author: Version v3.2.2
:author: Version v3.3.0
:doctype: book
:source-highlighter: rouge
:rouge-style: base16.monokai
Expand Down Expand Up @@ -34,6 +34,17 @@ https://liberapay.com/kigster/donate[image:https://liberapay.com/assets/widgets/
_Bashmatic®_ is a BASH framework, meaning its a collection of BASH functions (almost 900 of them) that, we hope, make BASH programming **easier, more enjoyable, and more importantly, fun** - due to the library's focus on providing the developer with a constant feedback about what is happening, while a script that uses Bashmatic's helpers is running.


[TIP]
====
We suggest that you learn about Bashmatic from the **https://github.com/kigster/bashmatic/blob/main/README.pdf[PDF version of this document]** which is much better for print.
* We recently began providing function documentation using a fork of `shdoc` utility. You can find the auto-generated documentation in the https://github.com/kigster/bashmatic/blob/main/doc/USAGE.md[USAGE] file, or it's https://github.com/kigster/bashmatic/blob/main/doc/USAGE.pdf[PDF] version.
* There is also an auto-generated file listing the source of every function and module. You can find it https://github.com/kigster/bashmatic/blob/main/doc/FUNCTIONS.adoc[FUNCTIONS].
* Additionally please checkout the https://github.com/kigster/bashmatic/blob/main/doc/CHANGELOG.md[CHANGELOG] and the https://github.com/kigster/bashmatic/blob/main/doc/LICENSE.adoc[LICENSE].
====

====
After you install the library (the default location is `~/.bashmatic`), realize that you have a choice of either:
Expand Down Expand Up @@ -87,17 +98,6 @@ Start exploring _Bashmatic®_ below with our examples section. When you are read
And, finally, don't worry, *_Bashmatic®_* is totally open source and free to use and extend. We just like the way it looks with a little *®* :)


[TIP]
====
We suggest that you learn about Bashmatic from the **https://github.com/kigster/bashmatic/blob/main/README.pdf[PDF version of this document]** which is much better for print.
* We recently began providing function documentation using a fork of `shdoc` utility. You can find the auto-generated documentation in the https://github.com/kigster/bashmatic/blob/main/doc/USAGE.md[USAGE] file, or it's https://github.com/kigster/bashmatic/blob/main/doc/USAGE.pdf[PDF] version.
* There is also an auto-generated file listing the source of every function and module. You can find it https://github.com/kigster/bashmatic/blob/main/doc/FUNCTIONS.adoc[FUNCTIONS].
* Additionally please checkout the https://github.com/kigster/bashmatic/blob/main/doc/CHANGELOG.md[CHANGELOG] and the https://github.com/kigster/bashmatic/blob/main/doc/LICENSE.adoc[LICENSE].
====

== Compatibility

* BASH version 4+
Expand Down
Binary file modified README.pdf
Binary file not shown.
Loading

0 comments on commit f7641b3

Please sign in to comment.