search

numberten / zhenya_bot

irc bot and official Haskell feature creep
Other
5 stars 1 forks source link

README is out of date #24

Closed numberten closed 10 years ago

numberten commented 10 years ago

README could use a redo.

Things we're missing:

numberten commented 10 years ago

42539c5 added MIT license

numberten commented 10 years ago

No longer sure if the passive component section is necessary for the v1.0 readme.

The command section might be something we can either move to a different markdown file, or drop completely upon implementation of #31.

Eventually it might be worth expanding upon documentation and making a new file along the lines of "how to roll your own component" that talks about passive services and such.

@fimad thoughts?

fimad commented 10 years ago

Yeah I think we probably don't need to list out every command if we implement the !man command or something similar. We could probably condense that section into something that talks more generally about the extensible of the component system with some examples maybe.

I think a how to roll your own component is a good idea. We might want to turn an example component into literate haskell file.

numberten commented 10 years ago

Then we're finished with the README as of 1.0. Our next steps documentation wise will be taken care of by #31 and #32, which address end-users at runtime and component developers respectively.