Merge pull request #142 from HyperInspire/dev/patch-4

Fix log api bug for android
HyperInspire · Jan 9, 2025 · f9ef90b · f9ef90b
2 parents a9c084e + 8bca5e4
commit f9ef90b
Showing 1 changed file with 15 additions and 4 deletions.
diff --git a/python/README.md b/python/README.md
@@ -1,12 +1,23 @@
-# PyInspireFace
+# InspireFace Python API
+
+We provide a Python API for calling InspireFace, which is implemented by wrapping the dynamic link library using ctypes. You can install the latest release version on your computer via pip from PyPI, or you can configure it using a self-compiled dynamic library with this project.
+
+## Quick Install
+
+For Python users on Linux and MacOS, InspireFace can be quickly installed via pip:
+
+```bash
+pip install inspireface
+```
+
 
 ## Setup Library
 
-You need to compile the dynamic linking library in the main project and then place it in **inspireface/modules/core**.
+You need to compile the dynamic linking library in the main project and then place it in **inspireface/modules/core/SYSTEM/CORE_ARCH/**.
 
 ```Bash
 # copy or link
-cp YOUR_BUILD_DIR/libInspireFace.so inspireface/modules/core
+cp YOUR_BUILD_DIR/libInspireFace.so inspireface/modules/core/SYSTEM/CORE_ARCH/
 ```
 
 ## Require
@@ -19,7 +30,7 @@ pip install tqdm
 pip install opencv-python
 ```
 
-## Quick Start
+## Simple example
 
 You can easily call the api to implement a number of functions: