Pārlūkot izejas kodu

Added new Build document and reloated documents

Thomas Davis 12 gadi atpakaļ
vecāks
revīzija
b742151013
9 mainītis faili ar 17 papildinājumiem un 7 dzēšanām
  1. 1 1
      Makefile
  2. 1 1
      Makefile.osx
  3. 7 0
      README.md
  4. 2 2
      civetweb.h
  5. 1 1
      distribution/arch/PKGBUILD.git.example
  6. 3 0
      docs/Building.md
  7. 0 0
      docs/Emedding.md
  8. 1 1
      docs/UserManual.md
  9. 1 1
      main.c

+ 1 - 1
Makefile

@@ -109,7 +109,7 @@ ifeq ($(TARGET_OS),LINUX)
 	install -Dm755 "$(CPROG)" "$(INSTALL_DIR)/usr/bin/$(CPROG)"
 	install -Dm644 "distribution/arch/$(CPROG).conf" "$(INSTALL_DIR)/etc/$(CPROG)/$(CPROG).conf"
 	install -d "$(INSTALL_DIR)/usr/share/$(CPROG)"
-	install -m644 "UserManual.md" "README.md" "$(INSTALL_DIR)/usr/share/$(CPROG)"
+	install -m644 "docs/UserManual.md" "README.md" "$(INSTALL_DIR)/usr/share/$(CPROG)"
 endif
 
 

+ 1 - 1
Makefile.osx

@@ -32,6 +32,6 @@ package: build
 	install -m 755 $(CPROG) $(OSXBIN_DIR)/$(PACKAGE)
 	ln -fs /Applications $(DMG_DIR)/
 	hdiutil create $(PACKAGE)_$(CIVETWEB_VERSION).dmg -volname "$(PACKAGE) $(CIVETWEB_VERSION)" -srcfolder $(DMG_DIR) -ov
-#	@rm -rf $(DMG_DIR)
+	@rm -rf $(DMG_DIR)
 
 #	V=`perl -lne '/define\s+CIVETWEB_VERSION\s+"(\S+)"/ and print $$1' $(LIB_SOURCES)`; DIR=dmg/Civetweb.app && rm -rf $$DIR && mkdir -p $$DIR/Contents/{MacOS,Resources} && install -m 644 build/civetweb_*.png build/civetweb.icns $$DIR/Contents/Resources/ && install -m 644 build/Info.plist $$DIR/Contents/ && install -m 755 Civetweb $$DIR/Contents/MacOS/ && ln -fs /Applications dmg/ ; hdiutil create Civetweb_$$V.dmg -volname "Civetweb $$V" -srcfolder dmg -ov #; rm -rf dmg

+ 7 - 0
README.md

@@ -16,6 +16,13 @@ https://github.com/sunsetbrew/civetweb/issues
 Discussion group is at Google Groups
 https://groups.google.com/d/forum/civetweb
 
+# Quick start documentation
+
+- [docs/UserGuide.md](https://github.com/sunsetbrew/civetweb/blob/master/docs/UserGuide.md) - End User Guide
+- [docs/Building.md](https://github.com/sunsetbrew/civetweb/blob/master/docs/Building.md) - Buildiing the Server Quick Start
+- [docs/Embedding.md](https://github.com/sunsetbrew/civetweb/blob/master/docs/Embedding.md) - Embedding Quick Start
+- [LICENSE](https://github.com/sunsetbrew/civetweb/blob/master/LICENSE) - Copyright License
+
 # Overview
 
 Civetweb keeps the balance between functionality and

+ 2 - 2
civetweb.h

@@ -55,7 +55,7 @@ struct mg_request_info {
 
 // This structure needs to be passed to mg_start(), to let civetweb know
 // which callbacks to invoke. For detailed description, see
-// https://github.com/sunsetbrew/civetweb/blob/master/UserManual.md
+// https://github.com/sunsetbrew/civetweb/blob/master/docs/UserManual.md
 struct mg_callbacks {
   // Called when civetweb has received new HTTP request.
   // If callback returns non-zero,
@@ -151,7 +151,7 @@ struct mg_callbacks {
 //   };
 //   struct mg_context *ctx = mg_start(&my_func, NULL, options);
 //
-// Refer to https://github.com/sunsetbrew/civetweb/blob/master/UserManual.md
+// Refer to https://github.com/sunsetbrew/civetweb/blob/master/docs/UserManual.md
 // for the list of valid option and their possible values.
 //
 // Return:

+ 1 - 1
distribution/arch/PKGBUILD.git.example

@@ -33,7 +33,7 @@ package() {
   install -Dm644 "$srcdir/$_pkgname/distribution/arch/$_pkgname.conf" "$pkgdir/etc/$_pkgname/$_pkgname.conf"
   install -Dm644 "$srcdir/$_pkgname/distribution/arch/$_pkgname.service" "$pkgdir/usr/lib/systemd/system/$_pkgname.service"
   install -d "$pkgdir/usr/share/$_pkgname"
-  install -m644 "$srcdir/$_pkgname/UserManual.md" "$srcdir/$_pkgname/README.md" "$pkgdir/usr/share/$_pkgname"
+  install -m644 "$srcdir/$_pkgname/docs/UserManual.md" "$srcdir/$_pkgname/README.md" "$pkgdir/usr/share/$_pkgname"
 }
 
 # vim:set ts=2 sw=2 et:

+ 3 - 0
docs/Building.md

@@ -0,0 +1,3 @@
+
+Building Civetweb
+=========

+ 0 - 0
Emedding.md → docs/Emedding.md


+ 1 - 1
UserManual.md → docs/UserManual.md

@@ -398,7 +398,7 @@ variable is visible in the block that follows.
 
 # Embedding
 
-See [Embedding.md](https://github.com/sunsetbrew/civetweb/blob/master/Embedding.md) for more information.
+See [Embedding.md](https://github.com/sunsetbrew/civetweb/blob/master/docs/Embedding.md) for more information.
 
 # Build on Android
 

+ 1 - 1
main.c

@@ -126,7 +126,7 @@ static void show_usage_and_exit(void) {
 static const char *config_file_top_comment =
 "# Civetweb web server configuration file.\n"
 "# For detailed description of every option, visit\n"
-"# https://github.com/sunsetbrew/civetweb/blob/master/UserManual.md\n"
+"# https://github.com/sunsetbrew/civetweb/blob/master/docs/UserManual.md\n"
 "# Lines starting with '#' and empty lines are ignored.\n"
 "# To make a change, remove leading '#', modify option's value,\n"
 "# save this file and then restart Civetweb.\n\n";