From 7a64213a322a5bfecafddd0e1a7139bba56fda70 Mon Sep 17 00:00:00 2001 From: Sylvain Tricot Date: Mon, 22 Feb 2021 15:52:42 +0100 Subject: [PATCH] Change list formatting. --- README.md | 57 ++++++++++++++++++++++++++++--------------------------- 1 file changed, 29 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index d79ae38..2327814 100644 --- a/README.md +++ b/README.md @@ -12,26 +12,26 @@ Requirements To compile MsSpec shared libraries, you need: - - Python >= 3.6 - - gfortran compiler - - cairo library (runtime files and header files) +- Python >= 3.6 +- gfortran compiler +- cairo library (runtime files and header files) Depending on your OS and Python version, you may need all the requirements (runtime libraries and header files) to build wxPython (please consult your distribution's package list for the appropriate package names) and their dependencies: - - python-dev (for your version of python) - - gtk (preferably version 3, but depends on your needs) - - gstreamer - - gstreamer-plugins-base - - glut - - libwebkitgtk (matching your gtk version) - - libjpeg - - libpng - - libtiff - - libsdl - - libnotify - - libsm +- python-dev (for your version of python) +- gtk (preferably version 3, but depends on your needs) +- gstreamer +- gstreamer-plugins-base +- glut +- libwebkitgtk (matching your gtk version) +- libjpeg +- libpng +- libtiff +- libsdl +- libnotify +- libsm You also need a tool to create and manage Python virtual environments. For now only *virtualenv* is supported. So if you plan to install msspec with the one-step command, @@ -70,23 +70,24 @@ make devel ``` This will: - - Create a Python virtual environment in the "\_venv" folder inside the msspec\_python3 folder. - - Install all the required Python packages in this virtual environment. - - Install (or even maybe build) wxPython for your OS and Python version in this virtual environment. - - Build the msspec shared librarires. - - Install msspec in *edit mode* in this virtual environment. + +- Create a Python virtual environment in the "\_venv" folder inside the msspec\_python3 folder. +- Install all the required Python packages in this virtual environment. +- Install (or even maybe build) wxPython for your OS and Python version in this virtual environment. +- Build the msspec shared librarires. +- Install msspec in *edit mode* in this virtual environment. You can tweak the process by specifying space separated key=value pairs on the command line. Allowed keys are: - - PYTHON, to give the executable name of the python interpreter to use rather than the default (python) - - VERBOSE, set to 1 if you want the install process to be more verbose - - NO\_VENV, set to 1 to not create a virtual environment - - VENV\_PATH, specify the path to a virtual environment root folder - - DEBUG, set to 1 to add debugging symbols - - BUILDDIR, to set a different name than the default to store building artifacts (./build) - - FC, the Fortran compiler to use (gfortran) - - F2PY +- PYTHON, to give the executable name of the python interpreter to use rather than the default (python) +- VERBOSE, set to 1 if you want the install process to be more verbose +- NO\_VENV, set to 1 to not create a virtual environment +- VENV\_PATH, specify the path to a virtual environment root folder +- DEBUG, set to 1 to add debugging symbols +- BUILDDIR, to set a different name than the default to store building artifacts (./build) +- FC, the Fortran compiler to use (gfortran) +- F2PY Work with msspec