Skip to content

Commit

Permalink
Merge pull request #63 from ProjectTorreyPines/docs
Browse files Browse the repository at this point in the history
Adding installation instructions, removed makefile
  • Loading branch information
anchal-physics authored Jul 13, 2024
2 parents 92c6c49 + bd3a5b0 commit 309e166
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 53 deletions.
31 changes: 5 additions & 26 deletions docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,34 +8,13 @@ Depth = 5

## Installation

### Using make:
After cloning this repo, check the make menu:
```
GGDUtils.jl % make help
Help Menu
GGDUtils is registered with public repository [FuseRegistry](https://github.com/ProjectTorreyPines/FuseRegistry.jl/). For installation:

make env_with_cloned_repo (or make r): Creates a Julia environment with the cloned repositories
make env_with_git_url (or make u): Creates a Julia environment with the git urls without creating local clones
make clean: Deletes Project.toml and Manifest.toml for a fresh start
```

#### make r
This option creates local copies of required private repositories at the same level as current repository and uses them in develop mode to create a Manifest.toml

#### make u
This option uses url of required private repositories to create a static Manifest.toml attached to current master branches of these repositories.

#### make clean
Deletes Manifest.toml so that environment can be recreated, to update or change the last used method.

### Using Julia REPL and installing using Github url

Or, in julia REPL:
```julia
julia> using Pkg;
julia> Pkg.add(; url="https://github.com/ProjectTorreyPines/IMASDD.jl.git");
julia> Pkg.add(; url="https://github.com/ProjectTorreyPines/GGDUtils.jl.git");
julia> Pkg.instantiate()
using Pkg
Pkg.Registry.add(RegistrySpec(url="https://github.com/ProjectTorreyPines/FuseRegistry.jl.git"))
Pkg.Registry.add("General")
Pkg.add("GGDUtils)
```

## Interpolations
Expand Down
27 changes: 0 additions & 27 deletions makefile

This file was deleted.

0 comments on commit 309e166

Please sign in to comment.