Skip to content

Incorperate Readme into Docs #129

@oxinabox

Description

@oxinabox

The readme is great and contains lost of useful information about how to use the package.
I think we should just run cp(joinpath("dirname(@__DIR__)/README.md"), joinpath(@__DIR__, "src", "index.md"))
in the docs/make.jl
and move the current index.md to be called "API Reference" or similar.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions