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

README.md #8

Open
jorenham opened this issue Dec 1, 2024 · 0 comments
Open

README.md #8

jorenham opened this issue Dec 1, 2024 · 0 comments
Labels
📝 docs Add or update documentation.
Milestone
v2021-12-0.0

Comments

@jorenham
Copy link
Collaborator

jorenham commented Dec 1, 2024 •
edited
Loading

It should at least have (n no particular order):

  • installation instructions
  • references to the main repo
  • an answer to questions like:
    • what's the problem that xpt solves?
      • why does that matter?
    • should I use it?
    • how can I use it?
    • does it support ?
    • can I use with with array-api 20XX.12.1?
    • will understand it?
    • how can I contribute?
    • what's up with the sparkly stuff? my eyes hurt!
  • badges, emojis, glitter, rainbows, unicorns etc.
@jorenham jorenham added the 📝 docs Add or update documentation. label Dec 1, 2024
@jorenham jorenham added this to the v2021-12-0.0 milestone Dec 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
📝 docs Add or update documentation.
Projects
None yet
Milestone
v2021-12-0.0
Development

No branches or pull requests
1 participant
@jorenham