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

Simplify README, move content to documentation #100

Open
wants to merge 20 commits into
base: develop
Choose a base branch
from
Open

Simplify README, move content to documentation #100

wants to merge 20 commits into from

Commits on Apr 10, 2024

  1. Reformat author list; add contributors 

    I followed the format of the Landlab AUTHORS.rst.
    @mdpiper
    mdpiper committed Apr 10, 2024
    Configuration menu
    Copy the full SHA
    e620343 View commit details
    Browse the repository at this point in the history

  2. Point link to develop branch

    @mdpiper
    mdpiper committed Apr 10, 2024
    Configuration menu
    Copy the full SHA
    8cbf67c View commit details
    Browse the repository at this point in the history

  3. Strip shell prompt symbol from commands 

    This makes it easier to copy-paste the commands.
    @mdpiper
    mdpiper committed Apr 10, 2024
    Configuration menu
    Copy the full SHA
    bb491a1 View commit details
    Browse the repository at this point in the history

  4. Remove conda instructions from source install 

    This fixes #99.
    @mdpiper
    mdpiper committed Apr 10, 2024
    Configuration menu
    Copy the full SHA
    5c4675f View commit details
    Browse the repository at this point in the history

  5. Rename 'input file' to 'configuration file'

    @mdpiper
    mdpiper committed Apr 10, 2024
    Configuration menu
    Copy the full SHA
    6c52e87 View commit details
    Browse the repository at this point in the history

  6. Add a link to the full documentation 

    This fixes #98.
    @mdpiper
    mdpiper committed Apr 10, 2024
    Configuration menu
    Copy the full SHA
    014a5a6 View commit details
    Browse the repository at this point in the history

  7. Tweak section comments in sample config file

    @mdpiper
    mdpiper committed Apr 10, 2024
    Configuration menu
    Copy the full SHA
    c0ed06f View commit details
    Browse the repository at this point in the history

  8. Replace 'generate' command with 'sample-config'; update output

    @mdpiper
    mdpiper committed Apr 10, 2024
    Configuration menu
    Copy the full SHA
    831408b View commit details
    Browse the repository at this point in the history

  9. Update decriptions of the babelizer configuration file

    @mdpiper
    mdpiper committed Apr 10, 2024
    Configuration menu
    Copy the full SHA
    fc82657 View commit details
    Browse the repository at this point in the history

Commits on Apr 11, 2024

  1. Remove the included readme from the docs

    @mdpiper
    mdpiper committed Apr 11, 2024
    Configuration menu
    Copy the full SHA
    de0de8f View commit details
    Browse the repository at this point in the history

  2. Move install instructions from README to docs 

    Keep a stub section in the README pointing to the docs.
    @mdpiper
    mdpiper committed Apr 11, 2024
    Configuration menu
    Copy the full SHA
    1bf6d16 View commit details
    Browse the repository at this point in the history

  3. Move "should I use the babelizer?" section to docs

    @mdpiper
    mdpiper committed Apr 11, 2024
    Configuration menu
    Copy the full SHA
    8badd0a View commit details
    Browse the repository at this point in the history

  4. Move configuration file section to docs

    @mdpiper
    mdpiper committed Apr 11, 2024
    Configuration menu
    Copy the full SHA
    0a773eb View commit details
    Browse the repository at this point in the history

  5. Add cross-referencing headings

    @mdpiper
    mdpiper committed Apr 11, 2024
    Configuration menu
    Copy the full SHA
    436ca1c View commit details
    Browse the repository at this point in the history

  6. Move use section from README to docs

    @mdpiper
    mdpiper committed Apr 11, 2024
    Configuration menu
    Copy the full SHA
    b2753ea View commit details
    Browse the repository at this point in the history

  7. Add contributing and acknowledgments sections to README

    @mdpiper
    mdpiper committed Apr 11, 2024
    Configuration menu
    Copy the full SHA
    777141e View commit details
    Browse the repository at this point in the history

  8. Tidy status badges

    @mdpiper
    mdpiper committed Apr 11, 2024
    Configuration menu
    Copy the full SHA
    be1f418 View commit details
    Browse the repository at this point in the history

  9. Add news fragment

    @mdpiper
    mdpiper committed Apr 11, 2024
    Configuration menu
    Copy the full SHA
    e853649 View commit details
    Browse the repository at this point in the history

Commits on Apr 12, 2024

  1. Use rtfd.io links for products

    @mdpiper
    mdpiper committed Apr 12, 2024
    Configuration menu
    Copy the full SHA
    d8d07a2 View commit details
    Browse the repository at this point in the history

  2. Update links to configuration file section of docs

    @mdpiper
    mdpiper committed Apr 12, 2024
    Configuration menu
    Copy the full SHA
    6c43e57 View commit details
    Browse the repository at this point in the history