Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Usage docs #68

Merged
merged 11 commits into from
Jun 2, 2020
Merged

Usage docs #68

merged 11 commits into from
Jun 2, 2020

Commits on May 19, 2020

  1. add usage markdown file translated automatically from the osm wiki

    @brettch
    brettch committed May 19, 2020
    Configuration menu
    Copy the full SHA
    c60dd18 View commit details
    Browse the repository at this point in the history

  2. add usage asciidoc file translated automatically from the osm wiki

    @brettch
    brettch committed May 19, 2020
    Configuration menu
    Copy the full SHA
    b769df9 View commit details
    Browse the repository at this point in the history

  3. use adoc extension for usage asciidoc

    @brettch
    brettch committed May 19, 2020
    Configuration menu
    Copy the full SHA
    f1117f7 View commit details
    Browse the repository at this point in the history

  4. add table of contents to usage

    @brettch
    brettch committed May 19, 2020
    Configuration menu
    Copy the full SHA
    9e1afcc View commit details
    Browse the repository at this point in the history

Commits on May 27, 2020

  1. update usage doc headings to use = prefix chars

    @brettch
    brettch committed May 27, 2020
    Configuration menu
    Copy the full SHA
    e21b609 View commit details
    Browse the repository at this point in the history

  2. remove markdown version of usage docs 

    Markdown doesn't support tables of contents which are very nice to have
when trying to navigate large numbers of command line options.
Asciidoc is similar in complexity to Markdown although less well known.
    @brettch
    brettch committed May 27, 2020
    Configuration menu
    Copy the full SHA
    cf83a4a View commit details
    Browse the repository at this point in the history

  3. move usage docs into doc folder

    @brettch
    brettch committed May 27, 2020
    Configuration menu
    Copy the full SHA
    311c814 View commit details
    Browse the repository at this point in the history

  4. add a link to detailed usage from the readme

    @brettch
    brettch committed May 27, 2020
    Configuration menu
    Copy the full SHA
    8a68af8 View commit details
    Browse the repository at this point in the history

  5. move development content into a separate markdown document

    @brettch
    brettch committed May 27, 2020
    Configuration menu
    Copy the full SHA
    0b0d668 View commit details
    Browse the repository at this point in the history

  6. update explanation of documentation locations

    @brettch
    brettch committed May 27, 2020
    Configuration menu
    Copy the full SHA
    378b35b View commit details
    Browse the repository at this point in the history

  7. rename usage to detailed-usage 

    The detailed usage is not intended to be an entry usage page so keep the
name as detailed usage to align with the name from the wiki.
    @brettch
    brettch committed May 27, 2020
    Configuration menu
    Copy the full SHA
    7039399 View commit details
    Browse the repository at this point in the history