search

QuantEcon / lecture-jax

Lectures on Quantitative Economics Using JAX
https://jax.quantecon.org/
28 stars 4 forks source link

MAINT: update README for standard format #147

Closed mmcky closed 3 months ago

mmcky commented 3 months ago

This PR updates the readme to move towards a standardized style across the lectures.

@jstac comments on this README I will capture for the .github/lectures/README.md template that I will then add to the QuantEcon manual to use when building a lecture repo.

see https://github.com/QuantEcon/meta/issues/132

netlify[bot] commented 3 months ago

Deploy Preview for incomparable-parfait-2417f8 ready!

Name Link
Latest commit 41778465d094add320cd7a010159497c266d363a
Latest deploy log https://app.netlify.com/sites/incomparable-parfait-2417f8/deploys/65e9341baf2a560008954054
Deploy Preview https://deploy-preview-147--incomparable-parfait-2417f8.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

github-actions[bot] commented 3 months ago

🚀 Deployed on https://65e9373bf661f199ce46a168--incomparable-parfait-2417f8.netlify.app

jstac commented 3 months ago

Thanks @mmcky . It would be great to standardize README files and .gitignores, although I realize it's not easy.

mmcky commented 3 months ago

@jstac is there anything else you think should be in (or out) of the README.

Currently I have included notebooks and issues (including a link to the QuantEcon manual re: style guide for PRs')

jstac commented 3 months ago

Looks good, made a minor suggestion above.