Mercurial > repos > ImageTools / changeset

--- a/README.md	Mon Mar 30 16:16:42 2020 -0500
+++ b/README.md	Mon Apr 20 09:23:28 2020 -0500
@@ -5,10 +5,36 @@
 
 This repository contains some tools for doing mathematical imaging in Julia:
 
-  * Effective visualisation based directly on `GR` instead of `Plots`. A sample visualisation main loop that calls `AlgTools`-style step routines. 
+  * Effective visualisation based directly on `GR` instead of `Plots`. A sample visualisation main loop that calls `AlgTools`-style step routines.
   * Sub-pixelresolution image translation and sub-image extraction
   * Calculation of discrete image gradients (2D, 3D 3D vector fields)
   * A very simple image filtering code that seems more efficient than the `ImageFiltering`
   package.
   
 The code is used, for example, by <http://dx.doi.org/10.5281/zenodo.3659180>.
+
+## Installation
+
+To install this package, first clone the repository and [AlgTools](https://tuomov.iki.fi/repos/AlgTools) with [Mercurial](https://www.mercurial-scm.org/):
+
+```console
+$ hg clone https://tuomov.iki.fi/repos/AlgTools/
+$ hg clone https://tuomov.iki.fi/repos/ImageTools/
+```
+
+(Canonical public repository URLs indicated here.)
+AlgTools has to be installed under the some location as ImageTools.
+Then add the repository to Julia with `Pkg.develop`:
+
+```console
+julia>] develop LOCATION_OF/ImageTools/
+```
+
+Here replace `LOCATION_OF/ImageTools` with path where you cloned AlgTools. (If you did not change directory after cloning, simply use `ImageTools`.)
+Afterwards, you may use the package with:
+
+```console
+julia> using ImageTools
+```
+
+This package is not and is not planned to be available via `Pkg.add` as it is based on the worst and must unusable version control system ever invented: Git.
\ No newline at end of file