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.

Sign up for GitHub

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

Jump to bottom

DOC: Add user guide in readme and contributing.md #61

Closed
pllim opened this issue Jun 22, 2018 · 4 comments
Closed

DOC: Add user guide in readme and contributing.md #61

pllim opened this issue Jun 22, 2018 · 4 comments
Assignees
@astrofrog

Comments

@pllim
Copy link
Member

pllim commented Jun 22, 2018

As discussed on June 22, 2018 telecon. cc @eteq
@pllim
Copy link
Member Author

pllim commented Jun 22, 2018

Update: @astrofrog added readme in df67346.

Tom, thanks for the readme. Should we include gotchas about running asv with multiple cores or VMs? Also, if we can somehow incorporate your Google Drive instructions into a proper doc here, that would be very nice as well.

@astrofrog
Copy link
Member

I will add the google doc to the astropy developer docs, and once it's there we can link to it from the README here.

@pllim
Copy link
Member Author

pllim commented Jun 25, 2018

@astrofrog , wasn't there discussion to also separate out dev doc away from core code doc? Perhaps that is out of scope here...

@astrofrog
Copy link
Member

In the end I added the instructions to the README here. Closing this!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@astrofrog astrofrog

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@astrofrog @pllim