haxelib special powers

[Franco Ponticelli]

I noticed that some libraries nicely expose a README.md and docs in the haxelib descriptions. What are the requirements for that? Are there other special powers we should know?

Thanks,

Franco

[Mark Knol]

As far as I know if you embed the readme.md in the haxelib zip it will get visible on the site.

[Franco Ponticelli]

I have it and it doesn't show up. Is it supposed to be case sensitive?

Il giorno gio 11 giu 2015 alle ore 14:19 Mark Knol <mark...@gmail.com> ha scritto:

As far as I know if you embed the readme.md in the haxelib zip it will get visible on the site.

--
To post to this group haxe...@googlegroups.com
http://groups.google.com/group/haxelang?hl=en
---
You received this message because you are subscribed to the Google Groups "Haxe" group.
For more options, visit https://groups.google.com/d/optout.

[Jeff Ward]

Interesting.

Flixel has it: http://lib.haxe.org/p/flixel/

OpenFL / hxcpp does not.

Downloading the .zip files, I notice that Flixel's README.md (and other files) are at the root level of the zip... hxcpp and openfl, the root only has a single folder which contains all files.

So, when you zip your lib for submission, are you puting README.md in the root, or everything in a subdir?

Best,

-Jeff

[Jeff Ward]

Your utest lib has it, and has README.md at root of zip:

http://lib.haxe.org/p/utest

I can't download thx.core for some reason, the download link the website provides (http://lib.haxe.org/p/thx.core/0.24.1/download/) returns "page not found".

[Franco Ponticelli]

They are both structured in the same way, they both have a README.md in the root of the project.

[Mark Knol]

I asked jason in a github issue to document it.

Afaik it should be in the root of the zip.

[Jeff Ward]

I notice that very few libs have dots in the name (thx.* and kong.js), and those libs are not downloadable via the links shown on the page:

Results in:

All other libs download fine.

I'm guessing this is implicated (website downloads, unzips, displays README.md -- but it can't find those libs with a dot in the name.)

Best,

-Jeff

[Franco Ponticelli]

That would make sense!

[Franco Ponticelli]

I reported the issue in the haxelib repo. Thanks!