Skip to content

Commit

Permalink
Merge pull request #3243 from JuliaReach/schillic/manual
Browse files Browse the repository at this point in the history
Update manual (getting started)
  • Loading branch information
schillic authored Feb 27, 2023
2 parents 26e0da3 + 9f335bb commit 4f75271
Showing 1 changed file with 1 addition and 26 deletions.
27 changes: 1 addition & 26 deletions docs/src/man/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,7 @@ To install `LazySets`, use the following command inside Julia's REPL:
```julia
julia> import Pkg; Pkg.add("LazySets")
```
or replace `add` by `clone` if you want to develop the code.
The full list of dependencies (which are automatically installed) is specified
in the [Project.toml](https://github.com/JuliaReach/LazySets.jl/blob/master/Project.toml) file.
or replace `add` by `develop` if you want to develop the code.


### Building the package
Expand All @@ -37,29 +35,6 @@ julia> using LazySets
This should precompile the package and make it available afterward.


## Workflow tips

There are different ways to use Julia: from the terminal, from the Julia REPL,
from IJulia (i.e., Jupyter notebook), from Juno, etc.
If you do not have a preferred choice, we recommend using `LazySets` through
IJulia;
one reason is that the visualization is conveniently embedded into the notebook,
and it can be exported into different formats, among other benefits.
On the other hand, for development purposes you probably want to use the REPL or
the Juno environment.


## Updating

After working with `LazySets` for some time, you may want to get the newest
version.
For this you can use the following command (e.g., from the REPL):
```julia
Pkg.checkout("LazySets")
```
That will check out the latest version in the `master` branch, and precompile it
the next time you enter a session and execute `using LazySets`.

## Optional dependencies

An optional dependency is a package that is not required to compile and use `LazySets.jl`,
Expand Down

0 comments on commit 4f75271

Please sign in to comment.