Added installation instructions for new pkg mode in README #20
Conversation
There was a problem hiding this comment.
I guess it's a bit inconsistent in it's current form. To use Pkg.add I have to using Pkg. So the upper suggestions only works on 0.6 and the lower one only on >= 0.7.
In my opinion, we should only write it for the 1.0 world. This is the major audience and people from pre 1.0 time are likely to know how do add the package anyway. Concretely, I'd just add a using Pkg.
Personally, I'd also drop the whole "Update" section. It seems irrelevant to me.
README.md
Outdated
| @@ -13,19 +13,27 @@ A very simple package for accessing elements in the Periodic Table! :fire: | |||
|
|
|||
| ## Installation | |||
| Since PeriodicTable is registered in `METADATA.jl`, you can directly install it like, | |||
| ```jl | |||
| ```julia | |||
| julia> Pkg.add("PeriodicTable") | |||
There was a problem hiding this comment.
Would this seem better? Later when we drop support for version 0.6, we will have this part removed.
# for version <= 0.6
julia> using Pkg
julia> Pkg.add("PeriodicTable")
# for version >= 0.7
julia>] # switch to pkg> mode
(v1.0) pkg> add PeriodicTableThere was a problem hiding this comment.
No, the upper one won't work on 0.6 (there exists no module Pkg on 0.6). As I said, I'd just drop the # for version ... comments and only give instructions for 0.7+.
If you would really want to indicate both ways (0.6 and 0.7+) then I'd switch the order (0.7+ first) and remove the using Pkg.
README.md
Outdated
|
|
||
| # OR | ||
| julia>] # switch to pkg> mode | ||
| (v1.0) pkg> update PeriodicTable |
|
Slightly OT, but I also thought about reversing the order in the One more thing (sorry :D), the "Data by" section should probably get a sentence that only parts of the data come from the JSON source. Some information has (and will be) added. |
|
I guess the |
README.md
Outdated
| @@ -13,19 +13,27 @@ A very simple package for accessing elements in the Periodic Table! :fire: | |||
|
|
|||
| ## Installation | |||
| Since PeriodicTable is registered in `METADATA.jl`, you can directly install it like, | |||
| ```jl | |||
| ```julia | |||
| julia> Pkg.add("PeriodicTable") | |||
There was a problem hiding this comment.
No, the upper one won't work on 0.6 (there exists no module Pkg on 0.6). As I said, I'd just drop the # for version ... comments and only give instructions for 0.7+.
If you would really want to indicate both ways (0.6 and 0.7+) then I'd switch the order (0.7+ first) and remove the using Pkg.
README.md
Outdated
| * [Periodic-Table-JSON](https://github.com/Bowserinator/Periodic-Table-JSON) | ||
| ### Data by | ||
| The data used for this package has been pulled up in parts from [here](https://github.com/Bowserinator/Periodic-Table-JSON) | ||
| Some information has been (and will be) added over the period of time. |
There was a problem hiding this comment.
"Some information has been (and will be) added over time." sounds better to me.
Also there seems to be a dot missing after the here link.
README.md
Outdated
| ``` | ||
| exports a global variable called `elements`, which is a collection of | ||
|
|
||
| In particular `PeriodicTable` exports a global variable called `elements`, which is a collection of | ||
| `Element` data structures. You can look up elements by name (case-insensitive) |
There was a problem hiding this comment.
I'd move the first sentence, "In particular PeriodicTable exports a global variable called elements, which is a collection of Element data structures. ", before the PT visualization.
|
Hopefully should be enough for now. |
| Since PeriodicTable is registered in `METADATA.jl`, you can directly install it like, | ||
| ```jl | ||
| ```julia |
There was a problem hiding this comment.
In the future we might have to replace METADATA.jl by the general registry on https://github.com/JuliaRegistries/General.
How to install/update using the
pkgmode/prompt.