Skip to content

Split setup instructions from README #466

@Aditya30ag

Description

@Aditya30ag

Description

The current README.md contains both high-level project information and detailed setup/build instructions. This makes the README long and harder to scan for new users who just want an overview of the project.

Proposal

Move all setup and build-related documentation into a dedicated SETUP.md file and keep the README concise by referencing it.

Benefits

  • Cleaner, more readable README
  • Clear separation between overview and setup instructions
  • Easier maintenance of setup documentation

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