From: juinanyen <juinanyen@gmail.com>
Date: Sun, 14 Feb 2021 10:53:06 +0000 (+0000)
Subject: Add more instructions for the python interface installation
X-Git-Tag: v243~3
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=67e8dd43ffbefbe6f8227f01ead8188d393922d4;p=liblinear

Add more instructions for the python interface installation
---

diff --git a/python/README b/python/README
index b7325d1..03d398c 100644
--- a/python/README
+++ b/python/README
@@ -23,27 +23,49 @@ for support vector machines (http://www.csie.ntu.edu.tw/~cjlin/liblinear). The
 interface is very easy to use as the usage is the same as that of LIBLINEAR. The
 interface is developed with the built-in Python library "ctypes."
 
-Installation
-============
+Installation via PyPI
+=====================
 
-To install via pip or conda, run
+To install the interface from PyPI, execute the following command:
 
 > pip install -U liblinear-official
 
-Alternatively, you may also directly use the Python interface without installing this package; see the following.
+Installation via Sources
+========================
+
+Alternateively, you may want to install the interface from sources and generate
+the LIBLINEAR shared library by yourself.
+
+Depending on your use cases, you can choose between systemwide installation and
+local directory installation. Microsoft Visual C++ and other tools might be
+required for systemwide installation for windows.
+
+- Systemwide Installation:
+
+    To have a systemwide access to the interface, execute the following command:
+
+    > pip install -e .
+
+    Please note that you still have to keep the sources after the installation.
+
+    In addition, please DON'T use other commands such as
+
+    > python setup.py install
+
+    or
+
+    > pip install .
 
-On Unix systems, type
+- Local Directory Installation:
 
-> make
+    On Unix systems, type
 
-The interface needs only LIBLINEAR shared library, which is generated by
-the above command. We assume that the shared library is on the LIBLINEAR
-main directory or in the system path.
+    > make
 
-For windows, the shared library liblinear.dll is ready in the directory
-`..\windows'. You can also copy it to the system directory (e.g.,
-`C:\WINDOWS\system32\' for Windows XP). To regenerate the shared library,
-please follow the instruction of building windows binaries in LIBLINEAR README.
+    For windows, the shared library liblinear.dll is ready in the directory
+    `..\windows'. You can also copy it to the system directory (e.g.,
+    `C:\WINDOWS\system32\' for Windows XP). To regenerate the shared library,
+    please follow the instruction of building windows binaries in LIBLINEAR README.
 
 Quick Start
 ===========