Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ufechner7 committed Nov 18, 2024
1 parent 546b87e commit 39edadc
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,32 @@ pkg"test KiteViewers"
```
This package should work on Linux, Windows and Mac. If you find a bug, please file an issue.

## Installation from git (for package developers)
First, fork this repository using the "Fork" button on the top of the website. Then, clone
your fork, e.g.:
```bash
git clone https://github.com/USERNAME/KiteViewers.jl
```
where you have to replace USERNAME with your github user name.
Then, run the installation script:
```bash
cd KiteViewers.jl
cd bin
./install
cd ..
```
The install script creates a version of `Manifest.toml` that works both with the normal project
and with the test environment, needed to run the examples.
To launch Julia, type:
```bash
./bin/run_julia
```
For more comfort, add this line to your `.bashrc` file:
```bash
alias jl='./bin/run_julia'
```
Then you can launch Julia, using the `run_julia` script just by typing `jl`.

## Exported types
```julia
Viewer3D
Expand Down

0 comments on commit 39edadc

Please sign in to comment.