Browse Source

Update README and Installing guide

bel2125 4 years ago
parent
commit
b1978ca94f
2 changed files with 29 additions and 23 deletions
  1. 15 3
      README.md
  2. 14 20
      docs/Installing.md

+ 15 - 3
README.md

@@ -86,6 +86,7 @@ Quick start documentation
 - [docs/OpenSSL.md](https://github.com/civetweb/civetweb/blob/master/docs/OpenSSL.md) - Adding HTTPS (SSL/TLS) support using OpenSSL.
 - [docs/OpenSSL.md](https://github.com/civetweb/civetweb/blob/master/docs/OpenSSL.md) - Adding HTTPS (SSL/TLS) support using OpenSSL.
 - [API documentation](https://github.com/civetweb/civetweb/tree/master/docs/api) - Additional documentation on the civetweb application programming interface ([civetweb.h](https://github.com/civetweb/civetweb/blob/master/include/civetweb.h)).
 - [API documentation](https://github.com/civetweb/civetweb/tree/master/docs/api) - Additional documentation on the civetweb application programming interface ([civetweb.h](https://github.com/civetweb/civetweb/blob/master/include/civetweb.h)).
 - [RELEASE_NOTES.md](https://github.com/civetweb/civetweb/blob/master/RELEASE_NOTES.md) - Release Notes
 - [RELEASE_NOTES.md](https://github.com/civetweb/civetweb/blob/master/RELEASE_NOTES.md) - Release Notes
+- [SECURITY.md](https://github.com/civetweb/civetweb/blob/master/SECURITY.md) - Security Policy
 - [LICENSE.md](https://github.com/civetweb/civetweb/blob/master/LICENSE.md) - Copyright License
 - [LICENSE.md](https://github.com/civetweb/civetweb/blob/master/LICENSE.md) - Copyright License
 
 
 
 
@@ -108,7 +109,7 @@ simplicity by a carefully selected list of features:
 - Scripting and database support (CGI, SQLite database, Lua Server Pages,
 - Scripting and database support (CGI, SQLite database, Lua Server Pages,
   Server side Lua scripts, Server side JavaScript).
   Server side Lua scripts, Server side JavaScript).
   This provides a ready to go, powerful web development platform in a one
   This provides a ready to go, powerful web development platform in a one
-  single-click executable with **no dependencies**.
+  single-click executable with **no dependencies**.0
 - Support for CGI, SSI, HTTP digest (MD5) authorization, WebSocket,
 - Support for CGI, SSI, HTTP digest (MD5) authorization, WebSocket,
   WebDAV.
   WebDAV.
 - HTTPS (SSL/TLS) support using [OpenSSL](https://www.openssl.org/).
 - HTTPS (SSL/TLS) support using [OpenSSL](https://www.openssl.org/).
@@ -138,6 +139,16 @@ simplicity by a carefully selected list of features:
 [![Duktape](https://raw.githubusercontent.com/civetweb/civetweb/master/resources/duktape-logo.png "Duktape Logo")](http://duktape.org)
 [![Duktape](https://raw.githubusercontent.com/civetweb/civetweb/master/resources/duktape-logo.png "Duktape Logo")](http://duktape.org)
 
 
 
 
+### Optional depencencies
+
+[![zlib](https://raw.githubusercontent.com/civetweb/civetweb/master/resources/zlib3d-b1.png "zlib Logo")](https://zlib.net)
+
+[![OpenSSL](https://raw.githubusercontent.com/civetweb/civetweb/master/resources/OpenSSL_logo.png "OpenSSL Logo")](https://www.openssl.org/)
+
+[![Mbed TLS](https://raw.githubusercontent.com/civetweb/civetweb/master/resources/mbedTLS_logo.png "mbedTLS Logo")](https://github.com/ARMmbed/mbedtls)
+
+
+
 Support
 Support
 -------
 -------
 
 
@@ -155,7 +166,7 @@ However, we cannot accept any responsibility for any content on an external page
 
 
 
 
 Contributions
 Contributions
----------------
+-------------
 
 
 Contributions are welcome provided all contributions carry the MIT license.
 Contributions are welcome provided all contributions carry the MIT license.
 
 
@@ -166,7 +177,8 @@ By now the code base differs, so patches cannot be safely transferred in either
 Some guidelines can be found in [docs/Contribution.md](https://github.com/civetweb/civetweb/blob/master/docs/Contribution.md).
 Some guidelines can be found in [docs/Contribution.md](https://github.com/civetweb/civetweb/blob/master/docs/Contribution.md).
 
 
 
 
-### Authors
+Authors
+-------
 
 
 CivetWeb has been forked from the last MIT version of Mongoose in 2013.
 CivetWeb has been forked from the last MIT version of Mongoose in 2013.
 Since then, CivetWeb has seen many improvements from various authors
 Since then, CivetWeb has seen many improvements from various authors

+ 14 - 20
docs/Installing.md

@@ -1,7 +1,9 @@
-Civetweb Install Guide
+CivetWeb Install Guide
 ====
 ====
 
 
-This guide covers the distributions for CivetWeb.  The latest source code is available at [https://github.com/civetweb/civetweb](https://github.com/civetweb/civetweb).
+This guide covers the pre-built binary distributions of CivetWeb.  
+The latest source code version is available at [https://github.com/civetweb/civetweb](https://github.com/civetweb/civetweb).
+
 
 
 Windows
 Windows
 ---
 ---
@@ -10,17 +12,18 @@ This pre-built version comes pre-built wit Lua support. Libraries for SSL suppor
 however, users may add an SSL library themselves.
 however, users may add an SSL library themselves.
 Instructions for adding SSL support can be found in [https://github.com/civetweb/civetweb/tree/master/docs](https://github.com/civetweb/civetweb/tree/master/docs)
 Instructions for adding SSL support can be found in [https://github.com/civetweb/civetweb/tree/master/docs](https://github.com/civetweb/civetweb/tree/master/docs)
 
 
-1. In case the Visual C++ Redistributable are not already installed:
-  32 Bit Version: Install the [Redistributable for Visual Studio 2010](http://www.microsoft.com/en-us/download/details.aspx?id=8328)
-  64 Bit Version: Install the [Redistributable for Visual Studio 2015](http://www.microsoft.com/en-us/download/details.aspx?id=48145)
-  Note: The required version of the Redistributables may vary, depending on the CivetWeb version.
+1. The "Visual C++ Redistributables" are already installed on most Windows PCs.
+   In case they are missing, you will see a "msvcr###.dll missing" error message when starting the server.
+   You need to download and install the [Redistributable for Visual Studio 2015](http://www.microsoft.com/en-us/download/details.aspx?id=48145)
+   Note: The required version of the Redistributables may vary, depending on the CivetWeb version.
 2. Download latest *civetweb-win.zip* from [SourceForge](https://sourceforge.net/projects/civetweb/files/)
 2. Download latest *civetweb-win.zip* from [SourceForge](https://sourceforge.net/projects/civetweb/files/)
-3. When started, Civetweb puts itself into the tray.
+3. When started, CivetWeb puts itself into the tray.
+
 
 
-Building civetweb - Using vcpkg
+Building CivetWeb - Using vcpkg
 ---
 ---
 
 
-You can download and install civetweb using the [vcpkg](https://github.com/Microsoft/vcpkg) dependency manager:
+You can download and install CivetWeb using the [vcpkg](https://github.com/Microsoft/vcpkg) dependency manager:
 
 
     git clone https://github.com/Microsoft/vcpkg.git
     git clone https://github.com/Microsoft/vcpkg.git
     cd vcpkg
     cd vcpkg
@@ -28,17 +31,8 @@ You can download and install civetweb using the [vcpkg](https://github.com/Micro
     ./vcpkg integrate install
     ./vcpkg integrate install
     ./vcpkg install civetweb
     ./vcpkg install civetweb
 
 
-The civetweb port in vcpkg is kept up to date by Microsoft team members and community contributors. If the version is out of date, please [create an issue or pull request](https://github.com/Microsoft/vcpkg) on the vcpkg repository.
-
-OS X
----
-
-This pre-built version comes with Lua, IPV6 and SSL support.
+The CivetWeb port in vcpkg is kept up to date by Microsoft team members and community contributors. If the version is out of date, please [create an issue or pull request](https://github.com/Microsoft/vcpkg) on the vcpkg repository.
 
 
-1. Download the latest *Civetweb.dmg* from [SourceForge](https://sourceforge.net/projects/civetweb/files/)
-2. Click on the it and look for the attachment in the finder.
-4. Drag Civetweb to the Applications folder.
-5. When started, Civetweb puts itself into top menu.
 
 
 Linux
 Linux
 ---
 ---
@@ -50,5 +44,5 @@ Linux
 5. make install
 5. make install
 6. Run the program ```/usr/local/bin/civetweb```, it will use the configuration file */usr/local/etc/civetweb.conf*.
 6. Run the program ```/usr/local/bin/civetweb```, it will use the configuration file */usr/local/etc/civetweb.conf*.
 
 
-Most Linux systems support auto completion of command line arguments.  To enable bash auto completion for the civetweb stand-alone executable, set *resources/complete.lua* as complete command.  See comments in that file for further instructions.
+Most Linux systems support auto completion of command line arguments.  To enable bash auto completion for the CivetWeb stand-alone executable, set *resources/complete.lua* as complete command.  See comments in that file for further instructions.