Hello,
wondering if people here can shed some light on few github things:
1) is possible to have a multi-line project description (the text at the top of https://github.com/kamailio/kamailio)? Maybe a special format (I tried to add \n or <br />, but they were displayed as is, not interpreted).
I would like to add a short note and a link to a page with commit guidelines (http://www.kamailio.org/wiki/devel/github-contributions), so new contributors make proper formatted commits. Displying it at the top will make it easy to spot, as opposity to adding to readme, which is shown at the bottom.
2) is there any specific content/marker to add to README to have it interpreted as markdown (without adding .md extensions)? Something like a special first or last line, ... It will be displayed nicer, but renaming will result in changing lot of other places (makefiles, deb/rpm specs, etc...) and somehow README is the traditional approach for the kind of this file name for Linux/Unix apps.
Cheers, Daniel
On 08/24/2015 02:34 PM, Daniel-Constantin Mierla wrote:
- is there any specific content/marker to add to README to have it
interpreted as markdown (without adding .md extensions)? Something like a special first or last line, ... It will be displayed nicer, but renaming will result in changing lot of other places (makefiles, deb/rpm specs, etc...) and somehow README is the traditional approach for the kind of this file name for Linux/Unix apps.
There's a special "github" markdown that shouldn't require a file: https://help.github.com/articles/github-flavored-markdown/
And of course a list of markups listed with https://github.com/github/markup.
Fred Posner The Palner Group, Inc. http://www.palner.com (web) +1-503-914-0999 (direct)
On 24/08/15 21:40, Fred Posner wrote:
On 08/24/2015 02:34 PM, Daniel-Constantin Mierla wrote:
- is there any specific content/marker to add to README to have it
interpreted as markdown (without adding .md extensions)? Something like a special first or last line, ... It will be displayed nicer, but renaming will result in changing lot of other places (makefiles, deb/rpm specs, etc...) and somehow README is the traditional approach for the kind of this file name for Linux/Unix apps.
There's a special "github" markdown that shouldn't require a file:
I don't understand what do you mean with the above, can you detail?
I was looking to get README displayed as markdown file by github.com on the website of kamailio project repository, without renaming it to README.md.
Cheers, Daniel
https://help.github.com/articles/github-flavored-markdown/
And of course a list of markups listed with https://github.com/github/markup.
Fred Posner The Palner Group, Inc. http://www.palner.com (web) +1-503-914-0999 (direct)
SIP Express Router (SER) and Kamailio (OpenSER) - sr-users mailing list sr-users@lists.sip-router.org http://lists.sip-router.org/cgi-bin/mailman/listinfo/sr-users
On 08/25/2015 06:23 AM, Daniel-Constantin Mierla wrote:
There's a special "github" markdown that shouldn't require a file:
I don't understand what do you mean with the above, can you detail?
I was looking to get README displayed as markdown file by github.com on the website of kamailio project repository, without renaming it to README.md.
Cheers, Daniel
I was incorrect.
Fred Posner The Palner Group, Inc. http://www.palner.com (web) +1-503-914-0999 (direct)
Le Tue, 25 Aug 2015 12:23:21 +0200, Daniel-Constantin Mierla miconda@gmail.com a écrit :
I was looking to get README displayed as markdown file by github.com on the website of kamailio project repository, without renaming it to README.md.
Maybe a symlink README.md -> README could do the trick?
Hello,
to update on this topic: at the end I added a new file README.md with informative details about project, mentioning the main README as the file for documentation and pointing to various resources of the project.
The file can be seen at:
* https://github.com/kamailio/kamailio/blob/master/README.md
Suggestions (and direct contributions by other devs) to it are welcome!
Cheers, Daniel
On 25/08/15 14:44, Camille Oudot wrote:
Le Tue, 25 Aug 2015 12:23:21 +0200, Daniel-Constantin Mierla miconda@gmail.com a écrit :
I was looking to get README displayed as markdown file by github.com on the website of kamailio project repository, without renaming it to README.md.
Maybe a symlink README.md -> README could do the trick?
-
Camille Oudot -
Daniel-Constantin Mierla -
Fred Posner