Skip to content

Commit

Permalink
Add install information on README and docs/src/index
Browse files Browse the repository at this point in the history
Adds the basic Julia pkg lines installation to these files.

Closes #297
  • Loading branch information
abelsiqueira committed Jul 8, 2024
1 parent 367eb13 commit 66fe3ae
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 0 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ Under the hood, `BestieTemplate` is no more and no less than:
Install `BestieTemplate` in your chosen environment (we recommend globally) by entering `pkg` mode by pressing `]` and then:

```julia-repl
julia> # press ]
pkg> add BestieTemplate
```

Expand Down
2 changes: 2 additions & 0 deletions docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ Check the [full guide](@ref full_guide) for more details.
However, if you kinda know what you need to do, this is the TL;DR:

```julia-repl
using> # press ]
pkg> add BestieTemplate
julia> using BestieTemplate
julia> BestieTemplate.generate("path/to/YourNewPackage.jl")
julia> # or BestieTemplate.apply("path/to/YourExistingPackage.jl")
Expand Down

0 comments on commit 66fe3ae

Please sign in to comment.