Create build.md

Author: hjain-perforce

build.md

@@ -0,0 +1,81 @@
+## Building P4Python from Source
+
+  1. Download the r22.2 Perforce C++ API from the Perforce FTP site at
+     "ftp://ftp.perforce.com/perforce". The API archive is located
+     in release and platform-specific subdirectories.
+
+     Under Linux the p4api is named p4api-glib<GLIBVER>-openssl<SSLVER>.tgz\
+     			 Note that setup.py will download the correct p4api automatically from
+           ftp.perforce.com if you do not provide an --apidir parameter to the 
+           setup.py "build" command.
+
+     Mac OS X users should get the API from the relevant platform directory e.g.
+     "**bin.macosx1010x86_64**" or "**bin.macosx12arm64**". The p4api is named
+     p4api-openssl<SSLVER>.tgz
+
+     Under Windows the p4api needs to match your compiler, build type (static 
+     or dynamic) and SSL version.  for instance:
+
+	   "**p4api_vs2010_static_openssl1.1.1.zip**" or\
+	   "**p4api_vs2015_dyn_openssl1.0.2.zip**"
+
+         Note: 32-bit builds of P4Python require a 32-bit version of the
+               C++ API and a 32-bit version of Python. 64-bit builds of
+               P4Python require a 64-bit version of the C++ API and a
+               64-bit version of Python.
+
+     Unzip the archive into an empty directory.
+
+  2. Download and extract the P4Python API archive into a new, empty directory.
+
+  3. If needed, install the Openssl libraries.
+
+  4. To build P4Python, run the following command:
+
+     	_python3 setup.py build --apidir <Perforce C++ API absolute path> 
+     	--ssl <OpenSSL library path> _
+
+	  	 Note: in order to reinstall cleanly P4Python, remove the
+               directory named "build".
+
+  5. To test your P4Python build, run the following command:
+
+     	_python3 p4test.py_
+
+		 Note: this test harness requires the Perforce server executable
+               p4d 17.1 or better to be installed and in the PATH.
+
+  6. To install P4Python, run the following command:
+
+      _python3 setup.py install_
+
+     if this doesn't work, you may need to both build and install in the same 
+     incantation:
+
+     _python3 setup.py build --apidir <Perforce C++ API absolute path> --ssl <OpenSSL library path> install_
+
+		 Note: on Unix/Mac platforms, the installation must be performed
+		       as the root user, so usually these commands are preceded by "sudo".
+		       Also ensure that the umask is set correctly (typically 0022) before 
+		       running the install. With a umask of 027, for example, the resulting 
+		       installed files are accessible only by users of group root.
+
+		       on Windows platforms, open a Visual Studio Command window
+	           (with administrator permissions) and run the command there.
+
+  SSL support
+  -----------
+
+    Perforce Server 2012.1 and later supports SSL connections and the
+    C++ API has been compiled with this support. With 2020.1 SSL support
+    is mandatory, that is, P4Python must be linked with valid OpenSSL libraries.
+
+    To specify which SSL library to use, provide the --ssl [librarypath]
+    switch to the build. Without [librarypath] setup will attempt to run
+    "openssl version" to identify the location of the library path for
+    openssl and whether openssl has an appropriate version to link to.
+
+    If on linux, and the build process cannot find the correct openssl 
+    libraries, and the -ssl option was not used, then the openssl source will 
+    be downloaded, compiled and installed (this will require a superuser 
+    password for the installation)