From 1b88234778399f5ac1ef491c5108026ed26d65b7 Mon Sep 17 00:00:00 2001 From: Archit Rungta Date: Fri, 9 Jul 2021 10:17:22 +0530 Subject: [PATCH] Add documentation for Julia binaries - GSoC --- modules/julia/README.md | 18 +++++++++++++++++- modules/julia/tutorials/julia.markdown | 15 ++++++++++++++- 2 files changed, 31 insertions(+), 2 deletions(-) diff --git a/modules/julia/README.md b/modules/julia/README.md index f460dabdbea..8ebf7f68557 100644 --- a/modules/julia/README.md +++ b/modules/julia/README.md @@ -2,7 +2,21 @@ OpenCV Julia Bindings ============================ This module contains some limited functionality that allows OpenCV functions be used from Julia. Upon installation the binding files are automatically registered with Julia's package manager like any normal package. -This module requires Julia 1.4 and the CxxWrap.jl 0.10. +This module requires Julia 1.4 and the CxxWrap.jl 0.10 when built from source. To use the compiled binary distributions Julia 1.6 is recommended. + +Using Prebuilt Binaries +--- +The easiest way to use OpenCV from Julia bindings is to use the version registered with Julia's package manager. This is also the only tested way to use Julia bindings on Windows. To do that simply start the Julia REPL. Hit `]` and then type `add OpenCV`. + +```bash +$ julia +... +julia> ] +pkg> add OpenCV +``` + +--- +The following steps walk over a source build of the Julia bindings. CxxWrap Installation ---- @@ -31,6 +45,8 @@ Install ------- By default the Julia package is installed in `CMAKE_BINARY_DIR`, you can change this by setting the `JULIA_PKG_INSTALL_PATH` cmake variable. The package is automatically registered with the Julia package manager. +--- + Run --- diff --git a/modules/julia/tutorials/julia.markdown b/modules/julia/tutorials/julia.markdown index f216daac4ea..c48bae85d10 100644 --- a/modules/julia/tutorials/julia.markdown +++ b/modules/julia/tutorials/julia.markdown @@ -20,6 +20,18 @@ The OpenCV bindings for Julia are created automatically using Python scripts at The generation process and the method by which the binding works are similar to the Python bindings. The only major difference is that CxxWrap.jl does not support optional arguments. As a consequence, it's necessary to define the optional arguments in Julia code which adds a lot of additional complexity. +How To Install The Bindings +----------------------- +The easiest and recommended way to install the bindings is using Julia's inbuilt package manager. OpenCV is available as a registered package for Julia and is supported on all major platforms and architectures. The following steps checked for correctness on Julia v1.6.1 + +TO install start the Julia REPL. Hit `]` and then type `add OpenCV`. + +```bash +$ julia +... +julia> ] +pkg> add OpenCV +``` How To Build The Bindings ----------------------- @@ -130,8 +142,9 @@ Note: The sample might take some time to load. Contributors ------------ -Below is the list of contributors of OpenCV.js bindings and tutorials. +Below is the list of contributors of OpenCV.jl bindings and tutorials. - Archit Rungta (Author of the initial version and GSoC student, Indian Institute of Technology, Kharagpur) - Sayan Sinha (GSoC mentor, Indian Institute of Technology, Kharagpur) +- Mosè Giordano (GSoC Phase 2 mentor) - Vadim Pisarevsky (GSoC mentor) \ No newline at end of file