jbilcke-hf HF staff commited on
Commit
af08fb2
โ€ข
1 Parent(s): cb05ba2

update readme

Browse files
Files changed (1) hide show
  1. README.md +12 -1
README.md CHANGED
@@ -44,6 +44,12 @@ It uses the face transformation routines from https://github.com/PowerHouseMan/C
44
 
45
  ## Installation
46
 
 
 
 
 
 
 
47
  ### Local Setup
48
 
49
  1. Clone the repository:
@@ -53,8 +59,13 @@ It uses the face transformation routines from https://github.com/PowerHouseMan/C
53
  ```
54
 
55
  2. Install Python dependencies:
 
 
 
 
 
56
  ```bash
57
- pip install -r requirements.txt
58
  ```
59
 
60
  3. Install frontend dependencies:
 
44
 
45
  ## Installation
46
 
47
+ ### Before you install
48
+
49
+ FacePoke has only been tested in a Linux environment, using `Python 3.10` and `CUDA 12.4` (so a NVIDIA GPU).
50
+
51
+ Contributions are welcome to help supporting other platforms!
52
+
53
  ### Local Setup
54
 
55
  1. Clone the repository:
 
59
  ```
60
 
61
  2. Install Python dependencies:
62
+
63
+ Using a virtual environment (Python venv) is strongly recommended.
64
+
65
+ FacePoke has been tested with `Python 3.10`.
66
+
67
  ```bash
68
+ pip3 install --upgrade -r requirements.txt
69
  ```
70
 
71
  3. Install frontend dependencies: