-
-
Notifications
You must be signed in to change notification settings - Fork 3
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
Conversation
Also, I did not document about entry points as I was unsure if it should go in README or in actual pybamm docs upstream. |
There was a problem hiding this 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 -
Co-authored-by: Saransh Chopra <[email protected]>
Co-authored-by: Agriya Khetarpal <[email protected]>
There was a problem hiding this 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.
Co-authored-by: Arjun Verma <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One final comment -
Co-authored-by: Saransh Chopra <[email protected]>
I added a bit more documentation in
README.md
. I have yet to add thepybamm-cookie
logo to the README and I will add it within this PR itself.#26