search

exoplanet-dev / jaxoplanet

Astronomical time series analysis with JAX
https://jax.exoplanet.codes
MIT License
41 stars 12 forks source link

docs:Update readme #135

Closed soichiro-hattori closed 9 months ago

soichiro-hattori commented 9 months ago

Starting a draft PR to address #122 and update the README.md file. To avoid having to maintain two duplicates of an intro doc, the README.md will be the file with content and index.md will simply keep track of the README.md file.

soichiro-hattori commented 9 months ago

@dfm: Here's a draft version of the new README/RTD landing page! I'm not entirely sure, but I think we might need to think about using absolute file paths when creating references since the README.md & index.md file exist in different directories? Also, would the toctree render in the README on Github?

soichiro-hattori commented 9 months ago

@dfm: There still isn't any text in the "Quick Start" part of the README.md file but otherwise I think it's ready to go for now!