search

astropy / astropy-benchmarks

Benchmarks for the astropy project
https://spacetelescope.github.io/bench/astropy-benchmarks/
BSD 3-Clause "New" or "Revised" License
7 stars 27 forks source link

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

Closed pllim closed 5 years ago

pllim commented 6 years ago

As discussed on June 22, 2018 telecon. cc @eteq

pllim commented 6 years ago

Update: @astrofrog added readme in df673460695b8f6372edeb4af9af9d9e933bf0d5.

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 commented 6 years ago

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 commented 6 years ago

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

astrofrog commented 5 years ago

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