Update README.md

Adding README.txt details from codeplex master branch
This commit is contained in:
v-mabarw 2014-07-22 16:05:34 -07:00
parent 0414441daf
commit 4166c4dae8

View file

@ -1,62 +1,77 @@
* Copyright and License Information *
# Microsoft Drivers for PHP for SQL Server
Copyright Microsoft Corporation
**Welcome to the Microsoft Drivers for PHP for SQL Server project!**
Licensed under the Apache License, Version 2.0 (the "License"); you
may not use this file except in compliance with the License.
The Microsoft Drivers for PHP for SQL Server are PHP 5 extensions that allow for the reading and writing of SQL Server data from within PHP scripts. The release contains two drivers, the SQLSRV driver and the PDO_SQLSRV driver. The SQLSRV extension provides a procedural interface while the PDO_SQLSRV extension implements PDO for accessing data in all editions of SQL Server 2005 and later (including SQL Azure). These drivers rely on the Microsoft SQL Server Native Client's ODBC driver to handle the low-level communication with SQL Server.
You may obtain a copy of the License at:
http://www.apache.org/licenses/LICENSE-2.0
Microsoft has published the source code to the driver on this site. With each successive update, we will revisit this plan. We've seen too many projects over-reach in their plans to be responsive to the community. We would prefer to start with a more conservative approach and make sure we're successfully delivering on that before expanding. We understand that many developers will download the source code to create their own build(s) of the driver. However, Microsoft supports only the Microsoft signed versions of the driver.
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied. See the License for the specific language governing
permissions and limitations under the License.
We hope you enjoy using the Microsoft Drivers for PHP for SQL Server.
* Notes about changes to the Microsoft Drivers 3.0 for PHP for SQL Server *
The Microsoft Drivers for PHP for SQL Server Team
For details about the changes included in this release, please see our blog at
http://blogs.msdn.com/sqlphp or see the SQLSRV_Readme.htm
file that is part of the download package.
## Announcements
* Notes about compiling the Microsoft Drivers 3.0 for PHP for SQL Server *
Please visit the [blog][blog] for announcements.
Prerequisites:
## Prerequisites
* You must first be able to build PHP without including these
extensions. For help with doing this, see the official PHP website,
http://php.net.
You must first be able to build PHP without including these
extensions. For help with doing this, see the [official PHP website][phpweb].
To compile the SQLSRV301 and PDO_SQLSRV301:
## Build
1) Copy the source code directories from this repository into the ext
To compile the SQLSRV and PDO_SQLSRV:
1. Copy the source code directories from this repository into the ext
subdirectory.
2) run buildconf.bat to rebuild the configure.js script to include the
2. Run buildconf.bat to rebuild the configure.js script to include the
new drivers.
3) run "cscript configure.js --enable-sqlsrv=shared --enable-pdo
--with-pdo-sqlsrv=shared <other options>" to generate the makefile.
3. Run "cscript configure.js --enable-sqlsrv=shared --enable-pdo
--with-pdo-sqlsrv=shared [other options]" to generate the makefile.
Run "cscript configure.js --help" to see what other options are
available. It is possible (and even probable) that other extensions
will have to be disabled or enabled for the compile to succeed.
Search bing.com for configurations that have worked for other people.
* It might be possible to compile these extensions as non-shared but that configuration has not been tested.
3a) It might be possible to compile these extensions as non-shared
but that configuration has not been tested.
4) run "nmake". It is suggested that you run the entire build. If you
4. Run "nmake". It is suggested that you run the entire build. If you
wish to do so, run "nmake clean" first.
5) To install the resulting build, run "nmake install" or just copy
5. To install the resulting build, run "nmake install" or just copy
php_sqlsrv.dll and php_pdo_sqlsrv.dll to your PHP extension directory.
Also enable them within your PHP installation's php.ini file.
This software has been compiled and tested under PHP 5.3.6 and later
using the Visual C++ 2008 and 2010, Express and Standard compilers.
* Note about version.h *
## Changes
For details about the changes included in this release, please see our [blog][blog] or see the SQLSRV_Readme.htm
file that is part of the download package.
## Known Issues
Please visit the [project on Github][project] to view outstanding [issues][issues].
## Notes
####Note about version.h
The version numbers in version.h in the source do not match the
version numbers in the supported PHP extension.
## License
The Microsoft Drivers for PHP for SQL Server are licensed under the Apache
2.0 license. See the LICENSE file for more details.
[blog]: http://blogs.msdn.com/b/sqlphp/
[project]: https://github.com/Azure/msphpsql
[issues]: https://github.com/Azure/msphpsql/issues
[phpweb]: http://php.net