Skip to content
This repository has been archived by the owner on Mar 27, 2018. It is now read-only.

New usage for README.md #17

Open
1 of 2 tasks
Hywan opened this issue Sep 28, 2015 · 6 comments
Open
1 of 2 tasks

New usage for README.md #17

Hywan opened this issue Sep 28, 2015 · 6 comments

Comments

@Hywan
Copy link
Member

Hywan commented Sep 28, 2015

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

  • Enhance README.md,
  • Use README.md instead of documentation when this latter is not written yet.
@Jir4
Copy link

Jir4 commented Feb 1, 2016

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

@Hywan
Copy link
Member Author

Hywan commented Feb 2, 2016

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
Copy link
Member Author

Hywan commented Feb 2, 2016

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

@vonglasow
Copy link
Member

vonglasow commented Jun 8, 2016

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 hoaproject/Central#19

@vonglasow
Copy link
Member

@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
Copy link
Member Author

Hywan commented Jun 17, 2016

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

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Development

No branches or pull requests

3 participants