Repository navigation
docs: update MOLE.jl installation instructions - #481
PandaHUN777 wants to merge 3 commits into
Conversation
There was a problem hiding this comment.
Copilot review overview
🟡 Changes recommended
Related documentation still contains contradictory outdated installation instructions.
Review effort: Lite
Findings: 1
What changed in this PR
Updates MOLE.jl installation instructions to use Julia’s package manager.
Changes:
- Replaces the outdated local-clone guidance with
Pkg.add("MOLE").
| File | Summary |
|---|---|
julia/MOLE.jl/README.md |
Updates package installation guidance. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| ## Installation | ||
|
|
||
| MOLE.jl is not yet available in the Julia's package manager. For now, this repository needs to be cloned locally in order to use the library in Julia. | ||
| MOLE.jl is available from the Julia package manager. In Julia, run `using Pkg; Pkg.add("MOLE")` to install it. |
There was a problem hiding this comment.
Updated docs/src/index.md to match the README's Julia package-manager installation instructions and removed the contradictory local-clone guidance. Documentation validation and git diff --check pass.
There was a problem hiding this comment.
Updated both julia/MOLE.jl/README.md and docs/src/index.md to establish standard package-manager usage (using MOLE) without requiring a repository clone, and relocated the clone-based --project=. instructions into a dedicated 'Development and working from source' section. Documentation validation and git diff --check pass.
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
fa03022 to
4c6b581
Compare
| ## Installation | ||
|
|
||
| MOLE.jl is not yet available in the Julia's package manager. For now, this repository needs to be cloned locally in order to use the library in Julia. | ||
| MOLE.jl is available from the Julia package manager. In Julia, run `using Pkg; Pkg.add("MOLE")` to install it. |
There was a problem hiding this comment.
Thank you for your contribution!
This line reads well now. Could you please also add another sentence for the other pkg mode? That is ] add MOLE. Thank you
There was a problem hiding this comment.
Added the alternative Julia package REPL mode instruction (] add MOLE) to both julia/MOLE.jl/README.md and docs/src/index.md. Thank you!
|
Hello @PandaHUN777 , thank you for your contribution. I would like to let you know that we cannot accept contributions from anonymous users (i.e., users that do not have a full display name in their GitHub account). This is to ensure that our Authorship attribution and DOI-bearing MOLE library User Manual document that is uploaded on the public Zenodo archive are reflective of real people contributions. |
|
This pull request has had no activity for 14 days. It will be marked |
github-actions
Bot
added
the
stale
|
Thanks for the discussion and work here. This pull request has had no activity for 28 days, so it is now marked |
What type of PR is this?
Description
Update the MOLE.jl installation instructions to use the Julia package manager, replacing the outdated note that the package was unavailable there.
Related issue
Closes #443
QA Instructions
Verified the package name, UUID, and repository subdirectory against the Julia General registry and the package metadata.
git diff --checkpasses.Added/updated tests?
Read Contributing Guide and Code of Conduct