Skip to content
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

Update README: installation instructions and development team #396

Merged
merged 2 commits into from
Sep 11, 2019

Conversation

ali-ramadhan
Copy link
Member

No description provided.

@ali-ramadhan ali-ramadhan added the documentation 📜 The sacred scrolls label Sep 11, 2019
@glwagner
Copy link
Member

glwagner commented Sep 11, 2019

How about changing

Installing Oceananigans through the built-in Julia package manager is a good idea because Julia will take care of all dependencies and let you update Oceananigans using a single command: ] update.

to something like

"We recommend installing Oceananigans.jl with the built-in Julia package manager, because this installs a stable, tagged release.

Oceananigans.jl can be updated to the latest tagged release from the package manager by typing

(v1.1) pkg> update Oceananigans

At this time, updating Oceananigans.jl should be done with care, as Oceananigans.jl is under rapid development and breaking changes to the user API occur often."

Do we want to also move the "Developers" section to the end of the README? Maybe expand the scope of this PR slightly while we are looking at it?

Edit: maybe we should also provide links to the julia documentation on how to use the built-in package manager?

Updated installation instructions to be more informative. Also moved development team section to the bottom so it's more like credits.
@codecov
Copy link

codecov bot commented Sep 11, 2019

Codecov Report

Merging #396 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #396   +/-   ##
=======================================
  Coverage   64.62%   64.62%           
=======================================
  Files          23       23           
  Lines        1405     1405           
=======================================
  Hits          908      908           
  Misses        497      497

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 079cb53...dd2f7f6. Read the comment docs.

1 similar comment
@codecov
Copy link

codecov bot commented Sep 11, 2019

Codecov Report

Merging #396 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #396   +/-   ##
=======================================
  Coverage   64.62%   64.62%           
=======================================
  Files          23       23           
  Lines        1405     1405           
=======================================
  Hits          908      908           
  Misses        497      497

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 079cb53...dd2f7f6. Read the comment docs.

@ali-ramadhan ali-ramadhan changed the title Better install instructions for new Julia users Update README: installation instructions and development team Sep 11, 2019
@ali-ramadhan ali-ramadhan merged commit 1b521b0 into master Sep 11, 2019
@ali-ramadhan ali-ramadhan deleted the better-install-instructions branch September 11, 2019 14:45
arcavaliere pushed a commit to arcavaliere/Oceananigans.jl that referenced this pull request Nov 6, 2019
)

Update README: installation instructions and development team

Former-commit-id: 1b521b0
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation 📜 The sacred scrolls
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants