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

[ENHANCEMENT] Clarify specifying URL in message about registering new package #38

Open
mtfishman opened this issue Dec 6, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@mtfishman
Copy link
Member

See the new instructions here: https://github.com/ITensor/ITensorRegistry?tab=readme-ov-file#registering-a-package

Maybe we should just link to those in

function pkg_registration_message(; pkgname, path)
return """
The package "$pkgname" has been generated at "$path".
To register the package in the [ITensor registry](https://github.com/ITensor/ITensorRegistry), first add
the registry if you haven't already with:
```julia
julia> using Pkg: Pkg
julia> Pkg.Registry.add(url="https://github.com/ITensor/ITensorRegistry")
```
or:
```julia
julia> Pkg.Registry.add(url="[email protected]:ITensor/ITensorRegistry.git")
```
if you want to use SSH credentials, which can make it so you don't have to enter your Github ursername and password when registering packages.
Then, use `LocalRegistry.jl` to register the package. First, you should add `LocalRegistry.jl` in your global environment. Then, activate the package and call:
```julia
using LocalRegistry: LocalRegistry
LocalRegistry.register()
```
"""
end
so we don't have to repeat things and can just update them in one place.

@mtfishman mtfishman added the enhancement New feature or request label Dec 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant