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

Write README and docstrings #7

Merged
merged 7 commits into from
Apr 14, 2023
Merged

Write README and docstrings #7

merged 7 commits into from
Apr 14, 2023

Conversation

baltpeter
Copy link
Member

@baltpeter baltpeter commented Apr 9, 2023

There's probably quite a lot more that we can (and should) say, but this should suffice for now. I've opened #8 with some TODOs.

This PR is based on #2, which should be merged first. This PR should be squash-merged.

@baltpeter baltpeter added the documentation Improvements or additions to documentation label Apr 9, 2023
@baltpeter baltpeter requested a review from zner0L April 9, 2023 16:35
README.md Outdated Show resolved Hide resolved
Copy link
Contributor

@zner0L zner0L left a comment

Choose a reason for hiding this comment

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

This is nicely written :)

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@baltpeter baltpeter requested a review from zner0L April 12, 2023 14:14
@zner0L zner0L merged commit e311a66 into main Apr 14, 2023
@zner0L zner0L deleted the b_readme branch April 14, 2023 18:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants