Skip to content
This repository was archived by the owner on Sep 14, 2019. It is now read-only.
This repository was archived by the owner on Sep 14, 2019. It is now read-only.

Convert README to Markdown #65

Description

@toolness

Currently the README is in reStructuredText, which has some disadvantages:

  • It's unintuitive compared to Markdown, especially for newcomers. (I haven't used it in a long time, and I'm having a difficult time making changes to it, especially given that I have no way to live-preview my changes on my local system.)
  • It's not possible to easily copy content to/from other Markdown content--e.g. other project READMEs, or instructions.md, or GitHub comments.

The only potential advantage I see in using RST is that it'll be easy to migrate our documentation to Sphinx, but I don't see that happening anytime soon...

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions