-
Notifications
You must be signed in to change notification settings - Fork 186
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.
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
README example is excessively large + README needs updating for current julia REPL look #961
Comments
my 2 cents: It's a bit "tricky" to have code in the README since with constant code upgrades oftentimes the README code gets outdated... |
That's true, probably best not to have too much. I personally find code in the README to be super helpful for "quick starting" though... |
Actually me too! |
Actually, it probably wouldn't be that hard to run code in the README in a test. Somebody should write a package for that. |
Could do something like using Markdown
readme = Markdown.parse(read("README.md", String))
julia_code_snippets = filter(c -> c isa Markdown.Code && c.language == "julia", readme.content)
for code_snippet in julia_code_snippets
# Need begin and end in case code snippet is multi-line.
Meta.parse("begin $(code_snippet.code) end") |> eval
end but then the code blocks under "Installation instructions" should not be |
That's ok for me... we really want "julia-repl" highlighting for those blocks anyways. Or, we can further-filter the lines that start with |
Actually wondering if we should provide code that installs julia: using Pkg
Pkg.add("Oceananigans")
Pkg.instantiate() Then people can copy paste like they really want to. If they know how to use the package manager, they already know what to do (or we can add a separate comment for such people). |
Hmmm, yeah copy-pastable code for installation might be better. Would rather use package mode but the benefit of being to copy paste is pretty sweet. |
We could use something like
|
Another README issue: we should change
to
|
I'm closing this issue because I'm judging that it's not of current, timely relevance to Oceananigans development. If you would like to make it a higher priority or if you think the issue was closed in error please feel free to re-open. |
The README example builds a grid of size (100, 100, 50), which is non-small. We should make the intro example more bite-size.
The text was updated successfully, but these errors were encountered: