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.

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

Extended documentation in README.md #47

Merged
merged 10 commits into from
Aug 20, 2024
Merged

Conversation

santacodes
Copy link
Collaborator

I added a bit more documentation in README.md. I have yet to add the pybamm-cookie logo to the README and I will add it within this PR itself.

#26

@santacodes
Copy link
Collaborator Author

Also, I did not document about entry points as I was unsure if it should go in README or in actual pybamm docs upstream.

Copy link
Member

@Saransh-cpp Saransh-cpp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, @santacodes! A few comments below -

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@santacodes santacodes mentioned this pull request Aug 19, 2024
16 tasks
Copy link
Member

@arjxn-py arjxn-py left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @santacodes, looks good.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Copy link
Member

@Saransh-cpp Saransh-cpp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One final comment -

README.md Outdated Show resolved Hide resolved
Co-authored-by: Saransh Chopra <[email protected]>
@santacodes santacodes merged commit 1b5e14e into pybamm-team:main Aug 20, 2024
84 checks passed
@santacodes santacodes deleted the doc branch August 30, 2024 12:39
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.

5 participants