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

add recommended install instructions on the readme? #62

Open
jerabaul29 opened this issue Apr 11, 2023 · 3 comments
Open

add recommended install instructions on the readme? #62

jerabaul29 opened this issue Apr 11, 2023 · 3 comments
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed

Comments

@jerabaul29
Copy link
Collaborator

Adding it on the readme directly may be useful for n00bs like me? :)

try latest main again. git clone + pip install -e . to replace the pip package.

may be enough, just so that the instructions are easily available? :)

@gauteh
Copy link
Member

gauteh commented Apr 11, 2023

Yes, instructions are here, but can be repeated: https://opendrift.github.io/trajan/#installation

more detailed instructions for installing a development version can follow this setup: https://opendrift.github.io/install.html

@jerabaul29
Copy link
Collaborator Author

Yes, this is where I got the installation instructions last, but:

  • I wonder if having this directly on the readme may be useful (though this is just taste / you should decide :) ), so I / users do not have to go through link after link to "just" install :)
  • the "install from git" was not listed, only the pypy pip and the conda :) - so could maybe be added there if you want to keep it all there rather than in the readme? :)

@gauteh
Copy link
Member

gauteh commented Apr 11, 2023

Yes, I agree, they should also be in the README. As with OpenDrift we try to guide the different users to the most appropriate method. For most it should be enough to just do either conda install trajan og pip install trajan.

@gauteh gauteh added documentation Improvements or additions to documentation help wanted Extra attention is needed labels May 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants