Jmaa/pretty
1
0
Fork 0
Code Actions

Small change to README.md

Browse Source
This commit is contained in:
Jon Michael Aanes 2017-06-05 22:08:33 +02:00
parent e98487fcae
commit 7ae38f1567
1 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -3,10 +3,10 @@
## Introduction ## Introduction
`pretty` is an advanced pretty printer for [Lua](lua.org). It attempts to `pretty` is an advanced pretty printer for [Lua](lua.org) aiming primarily for
understand your datastructures and return a pretty printed string human readability. This is done by looking for patterns in the input data, and
representation. It's primary purpose is to be a good human-readable debugging creating an output string utilizing and highlighting those patterns. Thus it's
tool, not a speedy serialization tool. a primarily a debugging tool, not a speedy serialization tool.
Humans are flexible in their understanding of data, as long as certain Humans are flexible in their understanding of data, as long as certain
underlying structural patterns can be found. `pretty` attempts to find those underlying structural patterns can be found. `pretty` attempts to find those
@ -76,6 +76,7 @@ I'm looking into implementing following features:
- Look into using concat operation to improve appearance of overly long - Look into using concat operation to improve appearance of overly long
non-breaking strings. Maybe even attempt to break near whitespace. non-breaking strings. Maybe even attempt to break near whitespace.
- Attempt to fit output within a predefined width limit. Default to 80(?) - Attempt to fit output within a predefined width limit. Default to 80(?)
- Find a better name than `pretty`.
## Other pretty printers ## Other pretty printers