From 09e1d07a4f84de8e22096f68661d2d1cbbfd92db Mon Sep 17 00:00:00 2001
From: pad <yoann.padioleau@gmail.com>
Date: Mon, 22 Apr 2024 18:07:30 +0200
Subject: [PATCH] more

---
 .github/workflows/build-and-test.jsonnet |  9 +++++----
 install.txt                              | 11 ++++++++---
 readme.txt                               |  2 ++
 3 files changed, 15 insertions(+), 7 deletions(-)

diff --git a/.github/workflows/build-and-test.jsonnet b/.github/workflows/build-and-test.jsonnet
index 0f8f7f0..e5ef6cd 100644
--- a/.github/workflows/build-and-test.jsonnet
+++ b/.github/workflows/build-and-test.jsonnet
@@ -22,10 +22,11 @@ local job = {
         //TODO: 'windows-latest'
       ],
       'ocaml-compiler': [
-        // Old OCaml version where I ported ocamlrun to plan9
-        // This needs stdcompat so we can use |> and bytes type without issues.
-        // The |> operator was introduced in 4.02.0, that we could add in
-        // the matrix, but stdcompat does not compile with it.
+        // Old OCaml version in which I ported the ocamlrun to plan9, which is
+	// why we care about it here. It does not support |> nor bytes though so
+        // we need stdcompat to compile without issues.
+        // Note that the |> operator was introduced in 4.02.0, which is a version 
+        // we could add in the matrix, but stdcompat does not compile with it.
         '3.10.0',
         // First OCaml version with a working ocamlformat OPAM package
         '4.04.1',
diff --git a/install.txt b/install.txt
index 3d65c80..18abd37 100644
--- a/install.txt
+++ b/install.txt
@@ -1,7 +1,12 @@
 Requirements:
- - OCaml (ocamlrun, ocamlc, OCaml stdlib)
- - kencc for kernel/ (until we can bootstrap it from the 5a/5c/5l in xix)
+ - OCaml (ocamlrun, ocamlc, OCaml stdlib), and OPAM
+ - The stdcompat and ocamlfind OPAM packages
+ - rc, the plan9 shell (until we can boostrap it from rc in xix)
+ - OPTIONAL: kencc for kernel/ (until we can bootstrap it from the 5a/5c/5l in xix)
 
 Then:
 	$ ./bootstrap-mk.sh
-	$ MKSHELL=bin/rc ./bin/mk
+	$ export PATH=`pwd`/bin
+	$ export MKSHELL=/path/to/rc
+	$ mk depend
+	$ mk
diff --git a/readme.txt b/readme.txt
index 4be2f2e..454cb61 100644
--- a/readme.txt
+++ b/readme.txt
@@ -3,3 +3,5 @@ Xix is Xix.
 This is the first fully recursive acronym for a project.
 
 This repository contains mostly Plan 9 programs ported to OCaml.
+
+Xix is not ready yet though, stay tuned.