update documentation

This commit is contained in:
Srdjan Milicev 2022-12-22 11:33:25 +01:00
parent 9f035971ed
commit 5d19123f0c
4 changed files with 13 additions and 20 deletions

View File

@ -37,10 +37,16 @@ To use these tools, you should be familiar with:
## External Software Dependencies ## External Software Dependencies
DNACalib's Python wrapper is compiled against Python 3.7. If you are using a different version of Python, you must recompile it. Any Python 3 version should be fine. DNACalib's Python wrapper is compiled against Python 3.7. Pre-compiled binaries for Windows and Linux (both 64-bit) are part of the repository.
Pre-compiled binaries for Windows and Linux (both 64-bit) are part of the repository. If you are using a different version of Python, you must recompile it. Any Python 3 version should be fine.
If a user has a different platform or architecture, the library and its dependencies must be compiled. If a user has a different platform or architecture, the library and its dependencies must be compiled.
**Important**
DNA files are stored as [LFS (Large File Storage)](https://git-lfs.github.com/) files. They are downloaded with the rest of the code if
git-lfs is installed and configured to use. If you are not using git-lfs, you have to download DNA files manually.
Additional information can be found [here](docs/faq.md#fix--runtimeerror--error-loading-dna--dna-signature-mismatched-expected-dna-got-ver-)
**Warning:** **Warning:**
Python 2 is not supported. Python 2 is not supported.

View File

@ -1,6 +1,6 @@
WINDOW_OBJECT = "dnaviewer" WINDOW_OBJECT = "dnaviewer"
WINDOW_TITLE = "DNA Viewer" WINDOW_TITLE = "DNA Viewer"
HELP_URL = "https://pages.github.ol.epicgames.net/MHTech/dna_calibration" HELP_URL = "https://epicgames.github.io/MetaHuman-DNA-Calibration/"
SPACING = 6 SPACING = 6
WINDOW_SIZE_WIDTH_MIN = 550 WINDOW_SIZE_WIDTH_MIN = 550

View File

@ -88,7 +88,7 @@ Prerequisites:
- [CMake](https://cmake.org/download/) at least version 3.14 - [CMake](https://cmake.org/download/) at least version 3.14
- [SWIG](https://www.swig.org/download.html) at least version 4.0.0 - [SWIG](https://www.swig.org/download.html) at least version 4.0.0
- [Python](https://www.python.org/downloads/) To specify the exact version of python3 to use, set the CMake variable - [Python](https://www.python.org/downloads/) To specify the exact version of python3 to use, set the CMake variable
`PYTHON3_EXACT_VERSION`. For example, to use the lib from Maya 2022, use minimum version 3.7. `PYTHON3_EXACT_VERSION`. For example, to use the lib from Maya 2022, use version 3.7.
Use CMake to generate the build scripts required for building, e.g. by executing the following commands from the Use CMake to generate the build scripts required for building, e.g. by executing the following commands from the
[`dna_calibration/dnacalib/`](/dnacalib) directory: [`dna_calibration/dnacalib/`](/dnacalib) directory:

BIN
docs/faq.md (Stored with Git LFS)

Binary file not shown.