Skip to content

Revamp README #3

@leandermaben

Description

@leandermaben

Let's fix the main README first. This will be the first step in an effort to improve documentation and reproducability.

  1. Make the README more comprehensive.
  2. Fix the repo structure (it has changed now)
  3. Add buttons showing website(will be setup later) and paper (https://arxiv.org/abs/2506.23049) and anything else relevant.
  4. Feel free to use parts of the paper to give a better overview in the main README. (We will make a more detailed doc of code structure in later issues)
  5. Use new image:Image
  6. Show how to cite in the end.

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