Documentation

[stephenmathieson]

We need dox for the following:

• package.json grammar (dependencies, makefile, etc.)
• "publishing" a package
• requesting membership to the org

[brendanashworth]

+1 this is definitely needed, especially the publishing a package.

[stephenmathieson]

@boboman13 for now, a user must:

1. ensure there is a ~package.json~ clib.json in the root of their project
2. log into GitHub
3. navigate to the "Packages" page of the wiki
4. press the "Edit" button
5. add an entry (in the appropriate section) following this format:

 - [boboman13/my-package](https://github.com/boboman13/my-package) - description of my package

Once added, clib-search(1) will be able to scrape the wiki page and display your package. If your package is not being displayed, you may need to run $ rm -f /tmp/clib-search.cache to remove its internal cache.

[tj]

Some docs encouraging everyone to make them glob-friendly would be nice too, my favorite thing about clib is knowing most of these work with a simple deps/*/*.c -I deps, no crazy build bullshit haha.

[jwerle]

Haha yes. It makes for a friendly Makefile.

On Sun, Oct 25, 2015, 7:11 PM TJ Holowaychuk [email protected] wrote:

Some docs encouraging everyone to make them glob-friendly would be nice too, my favorite thing about clib is knowing most of these work with a simple deps//.c -I deps, no crazy build bullshit haha.

— Reply to this email directly or view it on GitHub https://github.com/clibs/clib/issues/73#issuecomment-150986333.

[tj]

makes me

[jwerle]

:]

On Sun, Oct 25, 2015, 7:19 PM TJ Holowaychuk [email protected] wrote:

makes me https://camo.githubusercontent.com/474f0f1cfad35ec0d18971ecb29f0200f89c17b9/687474703a2f2f696d616765732e736f6461686561642e636f6d2f706f6c6c732f302f302f322f302f382f312f392f322f332f313331333833323234395f333633353732343231305f536572696f75734361745941595f616e737765725f315f786c617267652e6a706567

— Reply to this email directly or view it on GitHub https://github.com/clibs/clib/issues/73#issuecomment-150986777.