From 26730b415f93337e7384dba1f54012632c716b8d Mon Sep 17 00:00:00 2001
From: Brandon Rodriguez <brodriguez8774@gmail.com>
Date: Tue, 30 Nov 2021 04:41:39 -0500
Subject: [PATCH] Add potential fix for installation failure on VirtualBox VMs

---
 readme.md        | 9 +++++++++
 requirements.txt | 1 +
 2 files changed, 10 insertions(+)

diff --git a/readme.md b/readme.md
index d536f4c..a877d31 100644
--- a/readme.md
+++ b/readme.md
@@ -21,6 +21,15 @@ Then in a terminal with said environment, change to project root and run:
     pip install -r requirements.txt
 
 
+### Known installation issue on Ubuntu20 VirtualBox VMs
+
+You may run into an error when trying to install the `fclist` package, even when using Python3.9. In such a case, open
+up the requirements.txt file and comment the `fclist` line out. Then uncomment the `fclist-cffi` line.
+
+These packages appear to be interchangable, and doing this seems to allow package installation. The `fclist` package is
+still set as the default, if only because we've tested project runtime much more thoroughly with this package.
+
+
 ## Running the Project
 In a terminal with the above virtual environment loaded, change to project root and run:
 
diff --git a/requirements.txt b/requirements.txt
index ad856ae..833984d 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -11,6 +11,7 @@ pysdl2-dll~=2.0.16
 
 # System font-parsing dependencies.
 fclist~=1.1.1
+# fclist-cffi~=1.1.2        # Use this instead if you get a fclist error when running pip install.
 
 # Graph datastructure library.
 networkx~=2.6.3
-- 
GitLab