README.md

   1 # ustaxviewer
   2
   3 This package provides an HTML frontend to the [ustaxlib] system.
   4
   5 Every Form object that is added to the TaxReturn is viewable, with the value of every line
   6 displayed:
   7
   8 ![Main screen showing Form 1040](doc/f1040.png)
   9
  10 In order to aid debugging the computations, you can click the black line identifier to expand a flow
  11 graph showing the values that went into the computation. That includes the master computation for
  12 the "Amount You Owe", for example, which [yields this massive graph](doc/f1040-amount-owed.svg).
  13
  14 # Usage
  15
  16 See the [ustaxlib] repository for how to get started modeling taxes. To run the viewer, simply do:
  17
  18     npx ustaxviewer taxfile.ts
  19
  20 Note that `taxfile.ts` should have a default export of the TaxReturn object to be rendered.
  21
  22 [ustaxlib]: https://github.com/rsesek/ustaxlib