Add READMEs for tools that don't have one

docs/CMakeLists.txt

@@ -22,8 +22,10 @@ set(DOXYGEN_INPUT_DIR_LIST
     "${CMAKE_CURRENT_BINARY_DIR}/../source/slang/syntax"
     "${CMAKE_CURRENT_BINARY_DIR}/../source/slang/parsing")
 set(DOXYGEN_EXAMPLE_DIR_LIST
+    "${PROJECT_SOURCE_DIR}/tools/hier/README.md"
     "${PROJECT_SOURCE_DIR}/tools/netlist/README.md"
     "${PROJECT_SOURCE_DIR}/tools/reflect/README.md"
+    "${PROJECT_SOURCE_DIR}/tools/rewriter/README.md"
     "${PROJECT_SOURCE_DIR}/tools/tidy/README.md")
 set(DOXYGEN_EXTERNAL_DIR "${PROJECT_SOURCE_DIR}/external")
 set(DOXYGEN_STRIP_PATH "${DOXYGEN_INPUT_DIR}")

docs/tools.dox

@@ -7,8 +7,10 @@ well supported as the main slang library.
 
 @tableofcontents
 
+\include{doc} tools/hier/README.md
 \include{doc} tools/netlist/README.md
 \include{doc} tools/reflect/README.md
+\include{doc} tools/rewriter/README.md
 \include{doc} tools/tidy/README.md
 
 */

tools/hier/README.md

@@ -0,0 +1,33 @@
+slang-hier
+==========
+A tool that can display information about a Verilog hierarchy.
+
+This tool accepts the standard set of slang driver command line options,
+which lets you configure your design. Then the tool will display
+information like module instance names and resolved parameter values.
+
+Additional options to control output:
+
+`--params`
+
+Include instance parameter values in the output.
+
+`--max-depth <depth>`
+
+The maximum instance depth of the hierarchy to be printed.
+Everything deeper than that will be ignored.
+
+`--inst-prefix <prefix>`
+
+A hierarchical path indicating which hierarchy to display.
+All parts of the design not under this prefix will be ignored.
+
+`--inst-regex <regex>`
+
+Only instances that match the given regex (anywhere in the design tree)
+will be shown. All others will be skipped.
+
+`--custom-format <fmt>`
+
+A libfmt style format string that controls how the output is printed.
+Use `{inst}`, `{module}`, `{file}` as argument names in the string.

tools/rewriter/README.md

@@ -0,0 +1,12 @@
+rewriter
+========
+A simple tool that shows using the syntax API to read in a source file,
+parse it, and write it back out again. This can be used for testing purposes,
+to make sure syntax trees round trip correctly, or as a basic example of
+working with the syntax API.
+
+Usage:
+
+```
+rewriter <file-name>
+```

tools/tidy/README.md

@@ -1,4 +1,4 @@
-# Slang Tidy
+# slang-tidy
 
 A SystemVerilog linter