Skip to content

Commit 6da4a2f

Browse files
authored
Update README.md
1 parent a883062 commit 6da4a2f

File tree

1 file changed

+26
-14
lines changed

1 file changed

+26
-14
lines changed

README.md

Lines changed: 26 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -71,30 +71,42 @@ See [this example](https://github.com/ageitgey/face_recognition/blob/master/exam
7171

7272
## Installation
7373

74-
Requirements:
75-
* Python 3+ or Python 2.7
76-
* macOS or Linux (Windows untested)
77-
* [Also can run on a Raspberry Pi 2+ (follow these specific instructions)](https://gist.github.com/ageitgey/1ac8dbe8572f3f533df6269dab35df65)
78-
* A [pre-configured VM image](https://medium.com/@ageitgey/try-deep-learning-in-python-now-with-a-fully-pre-configured-vm-1d97d4c3e9b) is also available.
74+
### Requirements
7975

80-
Install this module from pypi using `pip3` (or `pip2` for Python 2):
76+
* Python 3.3+ or Python 2.7
77+
* macOS or Linux (Windows not officially supported, but might work)
78+
79+
### Installation Options:
80+
81+
#### Installing on Mac or Linux
82+
83+
First, make sure you have dlib alreayd installed with Python bindings:
84+
85+
* [How to install dlib from source on macOS or Ubuntu](https://gist.github.com/ageitgey/629d75c1baac34dfa5ca2a1928a7aeaf)
86+
87+
Then, install this module from pypi using `pip3` (or `pip2` for Python 2):
8188

8289
```bash
8390
pip3 install face_recognition
8491
```
8592

86-
IMPORTANT NOTE: It's very likely that you will run into problems when pip tries to compile
87-
the `dlib` dependency. If that happens, check out this guide to installing
88-
dlib from source (instead of from pip) to fix the error:
93+
If you are having trouble with installation, you can also try out a
94+
[pre-configured VM](https://medium.com/@ageitgey/try-deep-learning-in-python-now-with-a-fully-pre-configured-vm-1d97d4c3e9b).
8995

90-
[How to install dlib from source](https://gist.github.com/ageitgey/629d75c1baac34dfa5ca2a1928a7aeaf)
96+
#### Installing on Raspberry Pi 2+
9197

92-
After manually installing `dlib`, try running `pip3 install face_recognition`
93-
again to complete your installation.
98+
* [Raspberry Pi 2+ installation instructions](https://gist.github.com/ageitgey/1ac8dbe8572f3f533df6269dab35df65)
9499

95-
If you are still having trouble installing this, you can also try out this
96-
[pre-configured VM](https://medium.com/@ageitgey/try-deep-learning-in-python-now-with-a-fully-pre-configured-vm-1d97d4c3e9b).
100+
#### Installing on Windows
101+
102+
While Windows isn't officially supported, helpful users have posted instuctions on how to install this library:
103+
104+
* [@masoudr's Windows 10 installation guide (dlib + face_recognition)](https://github.com/ageitgey/face_recognition/issues/175#issue-257710508)
105+
106+
#### Installing a pre-configured Virtual Machine image
97107

108+
* [Download the pre-configured VM image](https://medium.com/@ageitgey/try-deep-learning-in-python-now-with-a-fully-pre-configured-vm-1d97d4c3e9b) (for VMware Player or VirtualBox).
109+
98110
## Usage
99111

100112
#### Command-Line Interface

0 commit comments

Comments
 (0)