Skip to content

Resolve "Improve the readme docs"

Christopher Wells requested to merge 165-improve-the-readme into master

Closes #165 (closed)

I wrote as much new documentation as I wanted as an introduction to repo.

Issues:

  • I removed some seemngly-unused dependencies (see pom.xml changes)?
  • Do we want ASCII art, or PNG, or ...?
  • I made a utility -- using typescript plus nodejs, attached here (index.ts) -- to create DEPENDENCIES.md ... but I don't know where if at all to add that to the braid repo. It isn't braid-specific, might work with any multi-module maven project.
Edited by Fuzz

Merge request reports