on master help sign in
Add examples to table of contents and drop the roadmap

[skip ci]

commit19deae563bb6edb1e20f2a1c9232005d9728d532 authormrkkrp <mark.karpov@tweag.io> dateWed 21 Aug 2019, 12:31 (7 years ago) parent6408a34
1 file changed+1−28
DESIGN.md+1−28
DESIGN.md+1−28
@@ -14,7 +14,7 @@
1414 * [Testing](#testing)
1515 * [Functionality of executable](#functionality-of-executable)
1616 * [Why not contribute to/fork Hindent or Brittany?](#why-not-contribute-tofork-hindent-or-brittany)
17−* [Roadmap](#roadmap)
17+* [Examples](#examples)
1818
1919This document describes design of a new formatter for Haskell source code.
2020It also includes recommendations for future implementers.
@@ -390,33 +390,6 @@ also possible that we'll find a nicer way to write pretty-printer.
390390
391391A list of formatting examples can be found [here](data/examples).
392392
393−## Roadmap
394−
395−Proposed roadmap (for a single person, about 39 full-time work days):
396−
397−* ~~Create and setup a repo, setup CI (less than 1 day).~~
398−* ~~Implement parsing (2 days).~~
399−* ~~Implement basis for pretty-printing of code. We could take
400− [this][hindent-printer] as inspiration, although AST from the `ghc`
401− package may be slightly different. Also, don't forget about annotations
402− and comments (1 week).~~
403−* Implement executable program so we can easier fool around. Try it on
404− simple code samples (2 days).
405−* Implement location and reading of configuration file in YAML format (2
406− days).
407−* Continue writing the pretty-printing code till we cover everything. Start
408− adding tests, see [the section about testing](#testing). Fix bugs. At this
409− point just repeat this till we cover everything that Brittany and Hindent
410− can do maybe by stealing their tests (at least 2 weeks).
411−* Start checking how our formatter works on real-world code from Hackage.
412− Fix bugs that we find that way (2 weeks).
413−* Write a good readme explaining why the project was created and how it is
414− better, etc (2 days).
415−* Switch CI to Travis and test with multiple GHC versions (1 day).
416−* Make and announce the first public release on Twitter/Reddit (1 day).
417−* Figure out how to use the formatter application with major text editors
418− and add the info to the readme (no estimate).
419−
420393[brittany]: https://hackage.haskell.org/package/brittany
421394[hindent]: https://hackage.haskell.org/package/hindent
422395[hindent-5-blog]: https://chrisdone.com/posts/hindent-5