Skip to content

Commit a062876

Browse files
author
Aranuvir
committed
refactor README.md mainly for Linux users ...
1 parent e68a086 commit a062876

File tree

1 file changed

+38
-8
lines changed

1 file changed

+38
-8
lines changed

README.md

+38-8
Original file line numberDiff line numberDiff line change
@@ -30,10 +30,10 @@ Builds for Windows platforms can be downloaded from http://www.makehumancommunit
3030

3131
If you rather run the code from source:
3232

33-
* Install git (https://git-scm.com/) with LFS support (https://git-lfs.github.com/). Modern git clients have LFS support included per default.
34-
* Make sure the command "git" is available via the PATH variable.
3533
* Install python 3.6.x or later from https://www.python.org/ (or via your system's package management). On windows you **MUST** use 64-bit python. 32-bit python will not work.
3634
* Install python dependencies (see the [Installing python dependencies](#installing-python-dependencies) section below)
35+
* Install [git](https://git-scm.com/) with [LFS support](https://git-lfs.github.com/). Modern git clients have LFS support included per default.
36+
* Make sure the command "git" is available via the PATH variable.
3737
* Use git to clone https://github.com/makehumancommunity/makehuman.git (or download the source as a zip)
3838
* Run the "download\_assets\_git.py" script in the "makehuman" subdirectory of the source code.
3939
* Optionally also run:
@@ -42,12 +42,41 @@ If you rather run the code from source:
4242
* compile\_targets.py
4343

4444
### Installing python dependencies
45+
MakeHuman depends on the following Python packages:
46+
47+
* numpy
48+
* PyQt5
49+
* PyOpenGL
50+
51+
Additionaly MakeHuman's shell plugin can make use of [IPython / Jupyter](https://jupyter.org/). You might also want to install these packages:
52+
53+
* jupyterlab
54+
* qtconsole
55+
56+
#### Installing python core dependencies on Linux
57+
It is recommended to install the aforementioned packages via the package manager of the operating system.
58+
59+
* __Debian / Ubuntu / Mint:__
60+
61+
`apt install python3-opengl python3-pyqt5 python3-pyqt5.qtopengl python3-pyqt5.qtsvg`
62+
63+
* __openSUSE:__
64+
65+
`zypper install python3-numpy python3-qt5 python3-opengl`
66+
67+
An alternative way to install dependencies is using __pip__. However, it is best practice to set up an [virtual environment](https://docs.python.org/3/library/venv.html)
68+
and activate it before using Python's package manager on a Linux system.
69+
For convenience, you might want to run:
70+
71+
`pip install -r requirements.txt`
72+
73+
#### Installing python core dependencies on Windows
4574
You should be able to start the command "pip" by opening a console prompt ("run" -> "cmd.exe") and writing "pip". If not,
46-
figure out how to run "pip": https://pip.pypa.io/en/stable/ (it should have been installed automatically by python)
75+
figure out how to run [__pip__](https://pip.pypa.io/en/stable/) (it should have been installed by python automatically):
4776

48-
Use "pip" to install dependencies. Running the following command will install all python dependencies:
77+
Use __pip__ to install dependencies. Running the following command will install all python dependencies:
4978

50-
* pip install -r requirements.txt
79+
`pip install -r requirements.txt`
5180

5281
### Installing plugins
5382

@@ -62,8 +91,10 @@ If you want to use community plugins like the asset downloader - download them,
6291

6392
Having done this, you can now start MakeHuman by running the makehuman.py script. On a prompt run
6493

65-
* python makehuman.py (on windows)
66-
* python3 makehuman.py (on debian, ubuntu, mint...)
94+
* python makehuman.py (on Windows)
95+
* python3 makehuman.py (on Debian, Ubuntu, Mint...)
96+
97+
Alternatively there is a shell script named _makehuman_ to start the application on Linux systems.
6798

6899
## Branches
69100

@@ -77,4 +108,3 @@ Read-only reference branches
77108
* bitbucket-default: This is the code as it looks in the "default" branch at bitbucket.
78109

79110
In addition you may from time to time see feature branches (usually named \_feature...), which are removed after having been merged to the master branch.
80-

0 commit comments

Comments
 (0)