Skip to content

Commit

Permalink
update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
smilicev committed Dec 22, 2022
1 parent 9f03597 commit 5d19123
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 20 deletions.
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,10 +37,16 @@ To use these tools, you should be familiar with:


## 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.
Pre-compiled binaries for Windows and Linux (both 64-bit) are part of the repository.
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.
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.

**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:**
Python 2 is not supported.

Expand Down
2 changes: 1 addition & 1 deletion dna_viewer/const/ui.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
WINDOW_OBJECT = "dnaviewer"
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

WINDOW_SIZE_WIDTH_MIN = 550
Expand Down
2 changes: 1 addition & 1 deletion docs/dnacalib.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ Prerequisites:
- [CMake](https://cmake.org/download/) at least version 3.14
- [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
`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
[`dna_calibration/dnacalib/`](/dnacalib) directory:
Expand Down
19 changes: 3 additions & 16 deletions docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,9 @@

## Fix "RuntimeError: Error loading DNA: DNA signature mismatched, expected DNA, got ver?"

DNA files are stored as [LFS](https://git-lfs.github.com/) files (Here is [another explanaintion](https://www.atlassian.com/git/tutorials/git-lfs) what LFS is).
This problem occurs when repo is downloaded as zip, and github then does not download LFS files as whole file, but as some metadata file.
Open that Ada.dna file in some editor file, from location were MetaHuman DNA Calibration is downloaded and then in
`data/dna/Ada.dna` (eg `c:/MetaHuman-DNA-Calibration/data/dna/Ada.dna` you will got this:

```
version https://git-lfs.github.com/spec/v1
oid sha256:e764cfab938283231bcb3e5af1c7bcbec5154bab4804aafa1b5b7dc6e400ca5e
size 73730354
```
Which is not valid DNA file.

There is two ways to fix this issue:
- `git clone git clone https://github.com/EpicGames/MetaHuman-DNA-Calibration.git`
- manually download [Ada.dna](../data/dna/Ada.dna) and/or [Taro.dna](../data/dna/Taro.dna), and put them in data directory
where you downloaded MetaHuman DNA Calibration. eg. `c:/MetaHuman-DNA-Calibration/data/dna`
In order to fix this issue, you should install [git-lfs](https://git-lfs.github.com/), and clone the repository again.
DNA files will be downloaded correctly then.
If you cannot install git-lfs, you can download DNA files manually.


## How do I distribute a Maya scene?
Expand Down

0 comments on commit 5d19123

Please sign in to comment.