From 2538acac2ced077a31c934e57ee6b1e112905504 Mon Sep 17 00:00:00 2001 From: Max Horn Date: Tue, 13 Nov 2018 21:27:59 +0100 Subject: [PATCH] Some README updates --- JuliaExperimental/README.md | 44 +++++++++++++++++++------------------ LibGAP.jl/README.md | 14 +++++------- README.md | 8 +++---- 3 files changed, 32 insertions(+), 34 deletions(-) diff --git a/JuliaExperimental/README.md b/JuliaExperimental/README.md index e1916357..47f6dd6c 100644 --- a/JuliaExperimental/README.md +++ b/JuliaExperimental/README.md @@ -1,14 +1,20 @@ # The GAP 4 package `JuliaExperimental' -JuliaExperimental provides experimental code to test and explore the capabilities of the JuliaInterface package, and the general combination of GAP and Julia. +JuliaExperimental provides experimental code to test and explore the +capabilities of the JuliaInterface package, and the general combination of +GAP and Julia. ## General Disclaimer - +## All code in this repository is preliminary work. -It comes with absolutely no warranty and will most likely have errors. If you use it for computations, please check the correctness of the result very carefully. +It comes with absolutely no warranty and will most likely have errors. If you +use it for computations, please check the correctness of the result very +carefully. -Also, everything in this repository might change in the future, so currently any update can break the code you wrote upon functionality from packages in this repository. +Also, everything in this repository might change in the future, so currently +any update can break the code you wrote upon functionality from packages in +this repository. This software is licensed under the LGPL, version 3, or any later version. @@ -16,8 +22,8 @@ This software is licensed under the LGPL, version 3, or any later version. ### Requirements -- Julia 0.6.2 or higher, compiled in `` -- GAP 4.9.1 or higher, compiled in `` +- Julia 1.1 or higher, compiled in `` +- GAP 4.11 or higher, compiled in `` - JuliaInterface, compiled in `` - The Julia packages Nemo.jl and Singular.jl @@ -27,17 +33,16 @@ This software is licensed under the LGPL, version 3, or any later version. - Compile the JuliaInterface package as described it its README.md - Start Julia and make sure Nemo.jl and Singular.jl are compiled, by typing - ``` - using Singular - using Nemo - ``` + + using Singular + using Nemo + - Configure and compile JuliaExperimental via - ``` - cd /../JuliaExperimental - ./autogen.sh - ./configure --with-gaproot= --with-julia=/usr --with-juliainterface= - make - ``` + + cd /../JuliaExperimental + ./autogen.sh + ./configure --with-gaproot= --with-julia=/usr --with-juliainterface= + make #### Notes for Mac OS X @@ -45,13 +50,10 @@ It is possible to link JuliaExperimental against the official Julia binary which one can download from . To do so, run configure as follows: - ./configure --with-julia=/PATH/TO/Julia*.app/Contents/Resources/julia + ./configure --with-julia=/PATH/TO/Julia*.app/Contents/Resources/julia ## Usage Load the JuliaExperimental package via -``` -LoadPackage( "JuliaExperimental" ); -``` - + LoadPackage( "JuliaExperimental" ); diff --git a/LibGAP.jl/README.md b/LibGAP.jl/README.md index 92435a1d..0563d8cb 100644 --- a/LibGAP.jl/README.md +++ b/LibGAP.jl/README.md @@ -1,12 +1,12 @@ OSCAR - LibGAP -------------- -This is some prototype code that uses a version of GAP as a library, -as found the GAP master branch, respectively in GAP 4.11, -to be able to call GAP functions from Julia. +This is some prototype code that uses a version of GAP as a library, as found +the GAP master branch, respectively in GAP 4.11 (to be released in 2019), to +be able to call GAP functions from Julia. Please don't use for any production code just yet, but do use it for -prototyping and let me know what's wrong with it. +prototyping and let us know about any issues with it you encounter. How to use ---------- @@ -21,17 +21,15 @@ You need the following ingredients: (if you did not install Julia but built it in director `$juliasrc`, then set `$juliadir` to `$juliasrc/usr`) -- The `GAPJulia` repository, checked out under `$oscarrepo` +- The `GAPJulia` repository, checked out under `$oscardir` -First we compile a version of GAP using the Julia installation in `$juliadir`, -and make sure a `libgap` shared library is compiled: +First compile a version of GAP using the Julia installation in `$juliadir`: cd $oscardir mkdir -p gap cd gap $gapdir/configure --with-gc=julia --with-julia=$juliadir make - make libgap.la Now we can compile JuliaInterface and JuliaExperimental: diff --git a/README.md b/README.md index 8e717645..d286e1fd 100644 --- a/README.md +++ b/README.md @@ -3,14 +3,12 @@ # GAPJulia Meta-package -This repository contains the GAP packages developed for the GAP-Julia integration as part of the +This repository contains the GAP and Julia packages developed for the GAP-Julia integration as part of the [OSCAR project](http://oscar.computeralgebra.de). -It currently consist of the packages -* JuliaInterface -* JuliaExperimental +It currently consist of the GAP packages `JuliaInterface` and `JuliaExperimental`, as well as the Julia package `LibGAP.jl`. -For a description of the packages and how to install them see the specific README.md files in the respective folders. +For a description of the packages and how to install them see the specific `README.md` files in the respective folders. ## General Disclaimer