www.digitalmars.com         C & C++   DMDScript  

digitalmars.D.learn - code.dlang.org package readme.md

reply Alexandru Ermicioi <alexandru.ermicioi gmail.com> writes:
Hi all.

How it is possible to show readme.md from github repository in 
code.dlang.org for a particular project?

Thanks.
Jan 03
next sibling parent Jesse Phillips <Jesse.K.Phillips+D gmail.com> writes:
On Tuesday, 3 January 2017 at 11:51:56 UTC, Alexandru Ermicioi 
wrote:
 Hi all.

 How it is possible to show readme.md from github repository in 
 code.dlang.org for a particular project?

 Thanks.
I believe this should be done automatically, however I suspect code.dlang.org is case sensitive and requires the file name to be README.md or something like that.
Jan 05
prev sibling parent ZombineDev <petar.p.kirov gmail.com> writes:
On Tuesday, 3 January 2017 at 11:51:56 UTC, Alexandru Ermicioi 
wrote:
 Hi all.

 How it is possible to show readme.md from github repository in 
 code.dlang.org for a particular project?

 Thanks.
Yes, code.dlang.org will display the readme file of the package if and only if it is named "README.md". For reference: https://github.com/dlang/dub-registry/blob/v2.0.0/views/view_package.dt#L128 https://github.com/dlang/dub-registry/blob/v2.0.0/source/dubregistry/registry.d#L351 The naming scheme is probably not set in stone (it just seemed to work ok in practice), so if you want you can open a pull request to make it more flexible.
Jan 06