Selaa lähdekoodia

Update documentation

bel 9 vuotta sitten
vanhempi
commit
daf2c2e5f4
3 muutettua tiedostoa jossa 15 lisäystä ja 6 poistoa
  1. 12 4
      docs/Building.md
  2. 1 1
      docs/Contribution.md
  3. 2 1
      docs/Embedding.md

+ 12 - 4
docs/Building.md

@@ -1,7 +1,7 @@
 Building Civetweb
 =========
 
-This guide covers the build instructions for stand-alone web server.
+This guide covers the build instructions for the stand-alone web server.
 See [Embedding.md](https://github.com/civetweb/civetweb/blob/master/docs/Embedding.md) for information on extending an application.
 
 #### Where to get the source code?
@@ -13,8 +13,8 @@ Building for Windows
 
 #### Using Visual Studio
 Open the *VS2012/civetweb.sln* in Visual Studio.
-To include SSL support, you may have to use yaSSL.  However, it is GPL licensed.
-See [yaSSL.md](https://github.com/civetweb/civetweb/blob/master/docs/yaSSL.md) for more information.
+To include SSL support, you may have to add an extra library for the cryptography support. You might wish to use yaSSL.  However, it is GPL licensed. See [yaSSL.md](https://github.com/civetweb/civetweb/blob/master/docs/yaSSL.md) for more information.
+Alternatively, you might wish to use OpenSSL. See [OpenSSL.md](https://github.com/civetweb/civetweb/blob/master/docs/OpenSSL.md) for more information.
 
 #### Using MinGW-w64 or TDM-GCC
 In the start menu locate and run the "Run terminal" batch file. For TDM-GCC this is named "MinGW Command Prompt".
@@ -23,6 +23,14 @@ Navigate to the civetweb sources directory and run:
 mingw32-make CC=gcc
 ```
 
+#### Using Qt Creator
+Open the Qt Designer project in the Qt folder
+
+#### Using CMake
+Except for Lua and Duktape support, CivetWeb can also be built with CMake.
+CMake can be used for all supported operating systems.
+
+
 Building for Linux, BSD, and OSX
 ---------
 
@@ -150,7 +158,7 @@ Building on Android
 This is a small guide to help you run civetweb on Android. Currently it is
 tested on the HTC Wildfire. If you have managed to run it on other devices
 as well, please comment or drop an email in the mailing list.
-Note : You dont need root access to run civetweb on Android.
+Note: You do not need root access to run civetweb on Android.
 
 - Download the source from the Downloads page.
 - Download the Android NDK from [http://developer.android.com/tools/sdk/ndk/index.html](http://developer.android.com/tools/sdk/ndk/index.html)

+ 1 - 1
docs/Contribution.md

@@ -4,7 +4,7 @@ Contributing to CivetWeb (**Draft**)
 Contributions to CivetWeb are welcome.
 
 - Please first create an issue on GitHub or create a thread on the CivetWeb discussion group.
-- If possible, create a pull request on GitHub. Please take care your modifications pass the continuouse integration checks. These checks are performed automatically when you create a pull request, but they may take some hours.
+- If possible, create a pull request on GitHub. Please take care your modifications pass the continuous integration checks. These checks are performed automatically when you create a pull request, but they may take some hours.
 - Alternatively, you can post a patch. However, pull requests are preferred.
 - Contributor names are listed in CREDITS.md, unless you don't want your name to be listed there.
 

+ 2 - 1
docs/Embedding.md

@@ -141,7 +141,7 @@ about web server instance:
 - a queue for accepted sockets
 - mutexes and condition variables for inter-thread synchronization
 
-When `mg_start()` returns, all initialization is quaranteed to be complete
+When `mg_start()` returns, all initialization is guaranteed to be complete
 (e.g. listening ports are opened, SSL is initialized, etc). `mg_start()` starts
 some threads: a master thread, that accepts new connections, and several
 worker threads, that process accepted connections. The number of worker threads
@@ -190,3 +190,4 @@ threads use blocking IO on accepted sockets for reading and writing data.
 All accepted sockets have `SO_RCVTIMEO` and `SO_SNDTIMEO` socket options set
 (controlled by the `request_timeout_ms` CivetWeb option, 30 seconds default) 
 which specifies a read/write timeout on client connections.
+