Skip to content

MAINT: update README for standard format#147

Merged
mmcky merged 3 commits intomainfrom
upd-readme
Mar 7, 2024
Merged

MAINT: update README for standard format#147
mmcky merged 3 commits intomainfrom
upd-readme

Conversation

@mmcky
Copy link
Copy Markdown
Contributor

@mmcky mmcky commented Mar 7, 2024

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 QuantEcon/meta#132

@netlify
Copy link
Copy Markdown

netlify bot commented Mar 7, 2024

Deploy Preview for incomparable-parfait-2417f8 ready!

Name Link
🔨 Latest commit 4177846
🔍 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
Copy link
Copy Markdown

github-actions bot commented Mar 7, 2024

@github-actions github-actions bot temporarily deployed to pull request March 7, 2024 01:48 Inactive
@jstac
Copy link
Copy Markdown
Contributor

jstac commented Mar 7, 2024

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

@mmcky
Copy link
Copy Markdown
Contributor Author

mmcky commented Mar 7, 2024

@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')

README.md Outdated
1. JS to-do: prioritize lectures
1. Suggest a benchmark example that we can build off
1. We will probably think differently about how to approximate and optimize
To contribute to the lectures please [raise an issue](https://github.com/QuantEcon/lecture-jax/issues) for any errata
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

To make it more generic and easier to copy and paste:

## Contributions

To comment on the lectures please add to or open an issue in the issue tracker (see above).

We welcome pull requests!  Please read the [QuantEcon style guide](https://manual.quantecon.org/intro.html) first, so that you can match our style.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Thanks @jstac I think this is a great suggestion.

@jstac
Copy link
Copy Markdown
Contributor

jstac commented Mar 7, 2024

Looks good, made a minor suggestion above.

@mmcky mmcky merged commit 2c2eec5 into main Mar 7, 2024
@mmcky mmcky deleted the upd-readme branch March 7, 2024 03:38
@mmcky mmcky restored the upd-readme branch March 7, 2024 03:38
@mmcky mmcky deleted the upd-readme branch March 7, 2024 03:38
@github-actions github-actions bot temporarily deployed to pull request March 7, 2024 03:40 Inactive
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.

2 participants