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

Rename and reform Installation section #161

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 37 additions & 5 deletions docs/src/10-full-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,17 +11,49 @@ Welcome to **full usage guide** of COPIERTemplate.
- On Julia, you can run `using UUIDs; uuid4()`
- Online, you can try [uuidgenerator.net](https://www.uuidgenerator.net/version4)

## Installation
## Usage

To install with COPIERTemplate.jl, install the package, use it, and run `COPIERTemplate.generate(path)`.
`COPIERTemplate` can be used in two ways:

Alternatively, this can also be installed directly via [copier](https://copier.readthedocs.io), with the command
### From `Julia` (recommended)

Install it:

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

Load it:

```julia-shell
> julia> using COPIERTemplate
```

Use it:

```julia-shell
> julia> COPIERTemplate.generate("<path>")
```

If `<path>` contains a `Julia` package, `COPIERTemplate` will add functionality ot it. If `<path>` is empty, `COPIERTemplate` will create a fresh new `Julia` package.

In order to customize your `Julia` package, `COPIERTemplate` will ask you a number of questions. If some of them are unclear, please [let us know](https://github.com/abelsiqueira/COPIERTemplate.jl/issues).

### From shell (advanced)

Alternatively, `COPIERTemplate` can also be used directly via Python's [copier](https://copier.readthedocs.io). See below:

Install `copier`:

```bash
copier copy https://github.com/abelsiqueira/COPIERTemplate.jl YourPackage.jl
pip install copier
```

Many questions will be asked. The explanation on them should be sufficient (if they aren't, please let us know).
Use it:

```bash
copier copy https://github.com/abelsiqueira/COPIERTemplate.jl YourPackage.jl
```

## Post-installation

Expand Down
Loading