facebookarchive/nailgun

Documentation is lacking

Opened this issue · 2 comments

eatkins commented

I can't find any link on the main page to any documentation. This old page http://www.martiansoftware.com/nailgun/quickstart.html is helpful. The api is not self-explanatory, especially given the fact that there is a client/server protocol, so some proper documentation would be appreciated. Note that the link to the nailgun website in the README.md just links back to the github landing page.

lhns commented

Maybe it would be helpful to enable the wiki functionality for this repo?
Then we could at least copy some of the old documentation there so that people can find it easier.

  • 👍3
ArturGajowy commented

Having at least some installation instructions would help greatly 🙏

  • 👍1