Skip to content

Commit

Permalink
Update README to better reflect the current status
Browse files Browse the repository at this point in the history
  • Loading branch information
joepal1976 committed Mar 5, 2018
1 parent 2ee02b9 commit 7006462
Showing 1 changed file with 42 additions and 11 deletions.
53 changes: 42 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,57 @@
# Makehuman (python3)
# Makehuman

This is now a near viable port of the current MakeHuman 1.1.1 stable branch to a Python 3 dependency version. The port
includes support for the pyside binding to QT4. This late addition recognizes the end of availability of the pyQt4 Python binding from Riverbank, and it allows testing to proceed. However, the intention is ultimately to move to QT5 support as final bugs are fixed.
This is a port of MakeHuman to Python 3 and PyQt5.

The testing vision for this code is to build a community release that includes the ported code and often-used, user-contributed
plug-ins. We hope that the utility of this integrated functionality is sufficient to entice a larger cohort of testers who get
value-added in exchange for the possibility of uncovering deficiencies in our port. When testing verifies it's robustness it should a suitable replacement for the current bitbucket code extending the future of MakeHuman beyond the Python 2 "end-of-life".

## Current status

WARNING: THE CODE IN THIS REPOSITORY IS CURRENTLY NOT FIT FOR PRODUCTION USE!

If you want a stable release of MakeHuman, see http://www.makehumancommunity.org/content/downloads.html

This said, the code in the master branch will work if a few basic requirements are met:

* NumPy must be at the most version 1.12.1. Versions 1.13.0 and later will not work.
* You must use a graphics card capable of using the opengl calls MH rely on. It is currently not easy to say exactly which these are, but a rule of thumb is that discreet graphics cards from nVidia will work, whereas integrated chips from intel are likely to not work.

## Getting started

Builds for Windows platforms can be downloaded at: http://download.tuxfamily.org/makehuman/nightly/. These builds include all required dependencies.

If you rather run the code from source:

* Install git (https://git-scm.com/) with LFS support (https://git-lfs.github.com/). Modern git clients have LFS support included per default.
* Make sure the command "git" is available via the PATH variable.
* Install python 3.5.x or later from https://www.python.org/ (or via your system's package management)
* Figure out how to run "pip": https://pip.pypa.io/en/stable/ (it should have been installed automatically by python)
* Use "pip" to install dependencies:
* "pip install numpy==1.12.1"
* "pip install pyqt5"
* "pip install numpy"
* Use git to clone https://github.com/makehumancommunity/makehuman.git (or download the source as a zip)
* Run the "download\_assets\_git.py" script in the "makehuman" subdirectory of the source code.
* Optionally also run:
* compile\_models.py
* compile\_proxies.py
* compile\_targets.py

Having done this, you can now start MakeHuman by running the makehuman.py script.

## Branches

There are three standard branches and some additional developer working branches:

* master: This is originally a branch of the code in bitbucket-stable (see below). This is where the python3 conversion happens, and it contains the latest version of MakeHuman
* master: This is where you will find the latest version of MakeHuman.

Read-only reference branches

* bitbucket-stable: This is the code as it looks in the "stable" branch at bitbucket. This is the ancestor of what is now the "master" branch.
* bitbucket-default: This is the code as it looks in the "default" branch at bitbucket.

Reference branches
* bitbucket-stable: This is the code as it looks in the stable branch at bitbucket
* bitbucket-default: This is the code as it looks in the default branch at bitbucket
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.

Developer branches
* Aranuvir's branch

A bug tracker for this port can be found at: http://bugtracker.makehumancommunity.org/projects/py3port/activity

Early binary builds for Windows platforms can be downloaded at: http://download.tuxfamily.org/makehuman/nightly/makehuman-python3-20170401-win32.zip

0 comments on commit 7006462

Please sign in to comment.