search

hoaproject / ActionBoard

Roadmap, actions, milestones… everything related to the schedule of Hoa is here
http://hoa-project.net/
2 stars 3 forks source link

New usage for `README.md` #17

Open Hywan opened 8 years ago

Hywan commented 8 years ago

We need enhanced README.md for each library (with more information in it). We also need to use README.md when the documentation is not written yet.

Tasks

Jir4 commented 8 years ago

Take a look at http://pandoc.org to convert markdown into html.

Hywan commented 8 years ago

I was not thinking about compiling them to HTML once. I prefer to do this on-the-fly, like we already do for XYL to HTML. We can probably use http://commonmark.thephpleague.com/ if it supports Github flavors.

Hywan commented 8 years ago

Else, we can check http://parsedown.org/.

vonglasow commented 8 years ago

Even, if it's obvious for a large part of us, I think a part regarding bug reporting can be useful. I have made a test in this first template version of README.

See also discussion about sections here https://github.com/hoaproject/Central/issues/19

vonglasow commented 8 years ago

@hoaproject/hoackers can we start with this version of template to align all README with it, or do you see any improvement.

I think it's not needed to have some section everywhere. like awecode section

Hywan commented 8 years ago

I would ask a feedback from @CircleCode before starting it.