diff --git a/readme.md b/readme.md index d536f4c70f1bce87ca3b5b8c5a96acb0a237f403..a877d315efa680ec7a653b7493b9910d20b0f81e 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 ad856ae7c3ff0a6120f2b0d7aee6009402d472ac..833984dcc05447b58620862860717b64ed10ef9f 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