Upgrade to Cubism 4 Release R3. No incompatible API changes.
[facial-landmarks-for-cubism.git] / README.md
index c912c7d..345fe15 100644 (file)
--- a/README.md
+++ b/README.md
@@ -43,13 +43,9 @@ if you don't have C++17 support.
 
 ## Build instructions
 
-1. Download OpenSeeFace from <https://github.com/emilianavt/OpenSeeFace>,
+1. Clone OpenSeeFace from <https://github.com/emilianavt/OpenSeeFace>,
    refer to its documentation and install its dependencies.
 
-   Note: I have forked OSF and added a small feature (flipping the webcam
-   feed horizontally like a mirror). If you want, you can clone my fork
-   instead: <https://github.com/adrianiainlam/OpenSeeFace>.
-
 2. Install dependencies.
 
    You will require a recent C/C++ compiler, `make`, `patch`, and CMake >= 3.16. To compile the example
@@ -71,17 +67,17 @@ if you don't have C++17 support.
 
 To build the example program:
 
-5. Download "Cubism 4 SDK for Native R2" from the Live2D website:
+5. Download "Cubism 4 SDK for Native R3" from the Live2D website:
    <https://www.live2d.com/en/download/cubism-sdk/download-native/>.
 
-   Extract the archive -- put the "CubismSdkForNative-4-r.2" folder under
+   Extract the archive -- put the "CubismSdkForNative-4-r.3" folder under
    the "example" folder of this repo.
 
    Note: The Cubism SDK is the property of Live2D and is not part of this
    project. You must agree to Live2D's license agreements to use it.
 
 6. Go into the
-   "example/CubismSdkForNative-4-r.2/Samples/OpenGL/thirdParty/scripts"
+   "example/CubismSdkForNative-4-r.3/Samples/OpenGL/thirdParty/scripts"
    directory and run
 
        ./setup_glew_glfw
@@ -97,8 +93,6 @@ To build the example program:
 
        ./python3 ./facetracker.py -v 4 --model 3 -M
 
-   The `-M` option is currently available only on my OSF fork.
-
    I tried models 3 and 4, and I think both work reasonably well.
    Please feel free to explore other options provided by OSF.