I am writing a Julia package that I want to make publicly available on GitHub. I am been following the instructions on this website:
I am mostly done. I used
pkg> add ... to indicate the package dependencies, as indicated on the web page, and that generated appropriate
Project.toml files. I created the functions that I want to put in the package, and I’ve added unit tests. But I’m struggling with the next few steps:
How do I probe the PATH to the package install directory? My package comes with a data file that I need to read to make the package work.
If I just put the package directory on GitHub, how would people install it? I’d like to add a
README.mdfile with basic installation instructions.
Following up on the previous question, how do I register the package so that people can type
Pkg.add("Planets")and have that work?
I don’t have a
REQUIREfile. Is that no longer needed for Julia 0.7 and later? Has it been fully replaced by
Julia packages on GitHub usually end in
.jl. Is that a requirement or just a popular convention? What happens if I don’t do that? I ask because I think I might want to leave the door open to using the same repository for a Python package.
Thanks for the help.