Merge pull request #114 from mhaas/update-readme

Update readme

Author: acv

NEWS

@@ -22,9 +22,11 @@ WiFiDog 1.2.0:
 	* Fix general code quality issues (#71, 74, #75, #86)
 	* Fix typo in ping_thread (pong -> PONG) (#46)
 	* Fix redirect by using HTTP 302 instead of 307 (#11, #14)  
-	* Upgrade libhttpd to 1.4 (#91)
 	* Fix inconsistent indent, now uses spaces everywhere (#91)
+	* Upgrade libhttpd to 1.4 (#91)
 	* Remove incomplete and broken BSD support (#93)
+	* Update doc/README.developers.txt (#113)
+	* Update README (-> README.md) (#114)
 	* Various other fixes and minor improvements, see
 		https://github.com/wifidog/wifidog-gateway/compare/1.1.5...1.2.0
 

README

@@ -0,0 +1,47 @@
+# WifiDog #
+
+The WiFi Guard Dog project is a complete and embeddable captive portal
+solution for wireless community groups or individuals who wish to open a
+free hotspot while still preventing abuse of their Internet connection.
+
+More information and the old issue tracker can be found on
+[dev.wifidog.org][homepage].
+Nowadays, development happens on [github][GitHub].
+
+
+## WifiDog Gateway ##
+
+WifiDog consists of two parts:
+
+* auth server
+* client daemon (the gateway)
+
+This repository contains the client daemon. The client typically runs on
+embedded hardware, e.g. the hotspot itself. The client is responsible for
+redirecting the user to the auth server where they may authenticate
+themselves. Depending on the response of the auth server, the client
+lifts the access restrictions for the user.
+Client and server speak the [WifiDog Protocol Version 1][protov1],
+with Version 2 being a draft which has not been implemented so far.
+A detailed description of the login process involving user,
+client and server is available as a [flow diagram][flowdia].
+
+## Install ##
+
+See the [faq][FAQ].
+
+## Contributing ##
+
+See [devdoc][README.developers.txt].
+
+
+## License ##
+The project's software is released under the GPL license and is copyrighted
+by its respective owners. See COPYING for details.
+
+[homepage]: http://dev.wifidog.org/
+[github]: https://github.com/wifidog/
+[protov1]: http://dev.wifidog.org/wiki/doc/developer/WiFiDogProtocol_V1
+[flowdia]: http://dev.wifidog.org/wiki/doc/developer/FlowDiagram
+[devdoc]: src/README.developers.txt
+[faq]: src/FAQ

README.md

@@ -4,24 +4,53 @@ $Id$
 
 This file contains some small notes on developing the WiFiDog application.
 
-The application's home page is:
-	http://www.ilesansfil.org/wiki/WiFiDog
 
-The application's sourceforge page is:
+The application's GitHub page is:
+	https://github.com/wifidog/
+
+As a developer, you should subscribe to the GitHub project:
+	https://github.com/wifidog/wifidog-gateway/subscription
+
+Main development is happening on GitHub, but the project website has lots of useful information
+and some remaining tickets:
+	http://dev.wifidog.org/
+
+There is also a (somewhat unused) SourceForge page:
 	http://sourceforge.net/projects/wifidog/
 
-As a developer, you must subscribe to sourceforge as a "developer" under WiFiDog, as well as subscribe to the WiFiDog mailing list located at:
-	http://listes.ilesansfil.org/cgi-bin/mailman/listinfo/wifidog
+WifiDog uses semantic versioning:
+	http://semver.org/
+
+
+CONTRIBUTION CHECKLIST:
+A quick checklist for new contributors. See below for details.
+	- Indent your code properly
+	- Document your code and follow DoxyGen style
+	- Your pull request must include an update to the NEWS file
+	- Fix all compiler warnings
+
+Once your patch is good to go, submit a pull request on GitHub:
+	https://github.com/wifidog/wifidog-gateway/pulls
 
+If you're having any questions, file an issue on GitHub and add the "Question"
+label:
+	https://github.com/wifidog/wifidog-gateway/issues/new
 
 SOURCE CODE:
 	- Please do not contribute unless you agree with the GPL license and are contributing your portion under that license.  See the included LICENSE.txt
 	- Please respect the intellectual property of others.  You are not allowed to taint WiFiDog by including source code from projects that do not allow so.
 	- Keep in mind that this application will run on extremely simple embedded devices.  The binary size needs to be small, the dependencies absolutely minimal, and the memory footprint negligible.
-	- Always place the subversion "Id" macro at the top of every file
 	- Since this is a collaborative project, please aim for clearness instead of cleverness when faced with a choice.
 	- If you must use some cleverness, please add appropriate clear comments.
-	- Please re-indent your code before committing to subversion - see the "Formatting Your Source Code" section in the GNU Coding Standards at http://www.gnu.org/prep/standards_toc.html - the entire document makes a good reading if you haven't read it before.  Also see the "indent" program.
+	- Please format your code properly before submitting a patch or a pull request. In general, we use 4 tabs instead of spaces with a maximum
+	  line length of 120. In VIM, use these settings:
+		set expandtab
+		set shiftwidth=4
+		set softtabstop=4
+		set tabstop=4
+	  The complete code style is defined by the following GNU indent call:
+		indent --linux-style --no-tabs --indent-level 4 --line-length 120 --procnames-start-lines
+	- Do not introduce compiler warnings. If the compiler warning is indeed harmless, disable it with the appropriate -Wno- flag in Makefile.am
 	- Before writing any brand-new large chunks of code, make sure it's logic has been discussed with the other team of developers or included in the design stage.
 
 
@@ -34,4 +63,5 @@ DOCUMENTATION:
 	- Please use DoxyGen-style comments (see http://www.doxygen.org/ for details) for source code documentation.
 	- Please use DocBook-SGML documentation for user documentation.  This will make it easy to export documentation in multiple formats.  Otherwise submit your documentation in plaintext format to someone who will change it to DocBook.
 	- Please thoroughly-comment non-clear sections in your code.
+	- Remember that commit messages and pull request descriptions also serve as a form of documentation.