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

Clean up README and clarify instructions #13

Merged
merged 8 commits into from
Aug 10, 2020
Merged

Clean up README and clarify instructions #13

merged 8 commits into from
Aug 10, 2020

Conversation

karthik
Copy link
Member

@karthik karthik commented Aug 3, 2020

I found the readme confusing and opened issue #11. Based on the invitation, I submit this PR to clean up the steps for publishing.

@pdebuyl
Copy link
Member

pdebuyl commented Aug 3, 2020

Hi @karthik

The start, "congratulations, ..." makes it look like the authors are the audience of the README. It is intended for editors only however, could

@pdebuyl
Copy link
Member

pdebuyl commented Aug 3, 2020

sorry, hit enter

... could you make the audience of the README explicit at the top? It is actually good that you put it that way, so it becomes more explicit who does what.

@karthik
Copy link
Member Author

karthik commented Aug 3, 2020

Happy to edit that out. I actually meant that for editors who visit this document a few times a year.

@pdebuyl
Copy link
Member

pdebuyl commented Aug 3, 2020

Indeed, it is congrats for "accepting" a paper, I read that too fast.

@rougier
Copy link
Member

rougier commented Aug 4, 2020

Ok, this is really much much better. Thanks a lot for writing it!

@rougier
Copy link
Member

rougier commented Aug 6, 2020

@khinsen @oliviaguest Any comment on that?

Copy link
Contributor

@khinsen khinsen left a comment

Choose a reason for hiding this comment

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

An enormous improvement, thanks! I have left some comment with cosmetic corrections.

@rougier rougier merged commit 040fb3b into master Aug 10, 2020
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.

4 participants