From 2a7a8db92f0a745e0f53cb5da074e8eded2ad747 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20B=C3=A9langer?= Date: Mon, 26 Sep 2022 13:43:37 -0400 Subject: [PATCH 1/2] Clarify README. --- README.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0ae757c..bc6d56f 100644 --- a/README.md +++ b/README.md @@ -38,13 +38,21 @@ This module has a few mandatory requirements: might work). ### Installation -You can install the module either by importing it `(import -(github.com/gambit/python))` or directly through gsi: +You can also install and compile the program at the command-line as such: ``` sh gsi -install github.com/gambit/python +gsc github.com/gambit/python ``` +You can also download and compile the module lazily by importing it from within +`gsi` or any program compiled with the C backend: + +``` scheme +(import (github.com/gambit/python)) +``` + + Gambit will download and compile the code. During compilation, the module will perform an automatic discovery of the installed CPython executable. Various C compiler options will be determined by introspection. This module will create a From 5de1122da28945bb8ff482f72fb33b3f2117b20e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc-Andr=C3=A9=20B=C3=A9langer?= Date: Mon, 26 Sep 2022 13:44:46 -0400 Subject: [PATCH 2/2] Proper wording. --- README.md | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index bc6d56f..7444d7d 100644 --- a/README.md +++ b/README.md @@ -38,25 +38,24 @@ This module has a few mandatory requirements: might work). ### Installation -You can also install and compile the program at the command-line as such: +You can install and compile the program at the command-line as such: ``` sh gsi -install github.com/gambit/python gsc github.com/gambit/python ``` -You can also download and compile the module lazily by importing it from within +or you can download and compile the module lazily by importing it from within `gsi` or any program compiled with the C backend: ``` scheme (import (github.com/gambit/python)) ``` - -Gambit will download and compile the code. During compilation, the module will -perform an automatic discovery of the installed CPython executable. Various C -compiler options will be determined by introspection. This module will create a -`virtualenv` to manage its packages. +In both cases, Gambit will download and compile the code. During compilation, +the module will perform an automatic discovery of the installed CPython +executable. Various C compiler options will be determined by introspection. This +module will create a `virtualenv` to manage its packages. Users can configure the compilation with environment variables: