Skip to content

Revamp README with new content and structure#769

Open
ndem0 wants to merge 4 commits into0.3from
readme
Open

Revamp README with new content and structure#769
ndem0 wants to merge 4 commits into0.3from
readme

Conversation

@ndem0
Copy link
Member

@ndem0 ndem0 commented Feb 17, 2026

Updated README to enhance structure, add installation instructions, and improve content clarity.

Description

Just a README revamping to fix the logo problem on PyPI and to a "News" section

This PR fixes #725

Checklist

  • Code follows the project’s Code Style Guidelines
  • Tests have been added or updated
  • Documentation has been updated if necessary
  • Pull request is linked to an open issue

Updated README to enhance structure, add installation instructions, and improve content clarity.
@ndem0 ndem0 requested a review from a team as a code owner February 17, 2026 09:22
@dario-coscia
Copy link
Collaborator

Very nice! I would also add Pytorch Ecosystem Blog as a badge. It would be nice to have it there.

Minor things:

  1. The API diagram needs some semantic updates; some arrows are not correct. We can think about it
  2. The code snippet should be highlighted with '''python<>'''
  3. The PDE equation can be written in pure markdown, I think it will render better
  4. I think there are too many emojis imho, but we can discuss it if you like them

Added badges for documentation, tutorial, version, license, and downloads to enhance README visibility.
Added an image and installation section to the README.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants