Skip to content

Commit

Permalink
update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
terasakisatoshi committed Dec 11, 2021
1 parent bbd3db6 commit ada43c8
Showing 1 changed file with 13 additions and 2 deletions.
15 changes: 13 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,23 @@

# Usage

## Setup `github.user`

- To run PkgTemplate.jl correctly, you should do (only once):

```console
$ git config --global github.user <your-github-account>
```

## Run `generate.jl`

- If you want to create a Julia package named "YourPkg", here is what you should do:

```console
$ cd /path/to/this/repository
$ julia generate.jl YourPkg # YourPkg.jl is generated
$ julia generate.jl YourPkg --with-jupyter # YourPkg.jl with Jupyter/Pluto.jl environment template is generated
$ julia --project=@. -e 'using Pkg; Pkg.instantiate()'
$ julia --project=@. generate.jl YourPkg # YourPkg.jl is generated
$ julia --project=@. generate.jl YourPkg --with-jupyter # YourPkg.jl with Jupyter/Pluto.jl environment template is generated
```

- Once you have done the instruction above, you can develop your Julia project.
Expand Down

0 comments on commit ada43c8

Please sign in to comment.