commit 46c473cd6ee2808be82d744f4b01fb0a9a247c16
parent 3b350075232cef2ced821d11e8613dafa2f2b9fa
Author: lash <dev@holbrook.no>
Date: Sat, 12 Nov 2022 15:00:42 +0000
Correct prefixes in current state of graphviz file
Diffstat:
2 files changed, 16 insertions(+), 8 deletions(-)
diff --git a/README.md b/README.md
@@ -1,8 +1,16 @@
+# Chaintool documentation
+
+
+## Showcasing chaintool
+
+The most intuitive entry point to chaintool is most likely the `eth-monitor` tool. It can be installed directly from `pypi` using `pip install eth-monitor`.
+
+
## Documentation for chaintool
-Chaintool is still very much a work-in-progress, and so to with its documentation.
+Chaintool is still very much a work-in-progress, and so too is its documentation.
-So far, documentation efforts have been made in three areas, in order of most maintained first:
+So far, documentation efforts have been made in four areas, in order of most recently updated first:
### Code dependency diagram
@@ -11,13 +19,13 @@ The dependency graph is only available in as an unformatted **graphviz** documen
Last time the author remembered to render it, it looked like this:
-
+
It is defined in terms of three layers:
* The lower layer (grey) consists of libraries that were developed within the context of `chaintool`, but have a higher generic scope.
-* The upper layer is all libraries that are considered part of the `chaintool` suite.
-* The higher layer (green) are tools and daemons building on the `chaintool` suite libraries.
+* The *core* layer contains all libraries that are considered part of the `chaintool` suite.
+* The higher layer (green) conprise of tools and daemons building on the `chaintool` suite libraries.
### Man pages
diff --git a/deps.dot b/deps.dot
@@ -16,10 +16,10 @@ digraph {
chaind [ label="hi/chaind", style="filled", fillcolor="#aaffaa" ];
chaind_eth [ label="hi/chaind-eth", style="filled", fillcolor="#aaffaa" ];
- eth_monitor [ label="eth-monitor", style="filled", fillcolor="#aaffaa" ];
+ eth_monitor [ label="hi/eth-monitor", style="filled", fillcolor="#aaffaa" ];
- eth_erc20 [ label="tool/eth-erc20", style="filled", fillcolor="#aaffaa" ];
- eth_erc721 [ label="tool/eth-erc721", style="filled", fillcolor="#aaffaa" ];
+ eth_erc20 [ label="hi/eth-erc20", style="filled", fillcolor="#aaffaa" ];
+ eth_erc721 [ label="hi/eth-erc721", style="filled", fillcolor="#aaffaa" ];
confini -> chainlib
hexathon -> chainlib
