From 39edadc59e82cf0c7aeaa1d9e7fd35c42dde86d3 Mon Sep 17 00:00:00 2001 From: Uwe Fechner Date: Mon, 18 Nov 2024 10:19:51 +0100 Subject: [PATCH] Update README.md --- README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/README.md b/README.md index 8624240..ba0a33e 100644 --- a/README.md +++ b/README.md @@ -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