Skip to content

Latest commit

 

History

History
54 lines (34 loc) · 1.31 KB

README.md

File metadata and controls

54 lines (34 loc) · 1.31 KB
Raw

lcmap-client-docs

Developer documentation for the family of LCMAP clients

Table of Contents

About ↟

This is the source for the LCMAP client library documentation site:

All supported client libraries are documented there.

This docs site utilizes TripIt's Slate project.

Development ↟

If you will be working on the LCMAP client docs locally or publishing changes to the Github docs site for LCMAP, you will need to have the appropraite tools installed on your system. You will need the following:

  • Ruby
  • Ruby gems

With those installed, you can set up all the other dependencies with the following:

$ make setup

This will install Ruby Bundler and then Slate's dependencies.

To run the development web server (serving content locally) while update the docs, you may do the following:

$ make devdocs

Once complete, you may publish with this target:

$ make publish