Hacker News new | ask | show | jobs
by no_protocol 3544 days ago
The writing in here looks pretty clean. My one suggestion would be to get some more examples in there. Most of the descriptions are one line and as a total outsider I just wanted to see some in action.

This document is much more appealing to me than the project's README. Since people often browse just the README when visiting a repository on GitHub, I wonder if you would be better off getting some of the language from sections 1 and 2 into the top of your README. The current README Overview just didn't do it for me. As soon as I saw the first two sections of the user manual, I was more interested because it showed what problem you were solving and how.

> Warning - This manual may reflect a future state of szl.

Got a chuckle out of me.