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

README.md instead of rst #44

Merged
merged 2 commits into from
Dec 6, 2019
Merged

README.md instead of rst #44

merged 2 commits into from
Dec 6, 2019

Conversation

amureki
Copy link
Collaborator

@amureki amureki commented Dec 3, 2019

  1. Switch rst to md
  2. Add a basic example to catch attention
  3. Add some more things to MANIFEST.in
  4. setup.py improvements

@amureki amureki added enhancement New feature or request WIP labels Dec 3, 2019
@amureki amureki self-assigned this Dec 3, 2019
@amureki
Copy link
Collaborator Author

amureki commented Dec 3, 2019

@model-bakers/core what do you think about switching README to md format?
It is much easier to work with (at least in my opinion) and pypi supports it as well.

I've added some unrelated updates to setup.py since I was on it... But we can do it separately.

@berinhard
Copy link
Member

Thanks for helping with this! Maybe we can also migrate our docs at some point to format it using Markdown with Sphinx. I created #47 to address that.

@berinhard berinhard merged commit 4ded6ab into master Dec 6, 2019
@berinhard berinhard deleted the readme.md branch December 6, 2019 14:52
@anapaulagomes
Copy link
Contributor

Wasn't this PR a WIP? @berinhard @amureki

@amureki
Copy link
Collaborator Author

amureki commented Dec 6, 2019

@anapaulagomes @berinhard I was just not sure if you would have some suggestions on top of it. But we anyways can iterate further if needed, that's a good changing point. :)

@anapaulagomes
Copy link
Contributor

Alright then! 👍 Thanks @amureki and @berinhard!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request WIP
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants