From 875810d02359f88f6978e1dec1c90ca8daf76ad8 Mon Sep 17 00:00:00 2001 From: Georg Hopp Date: Sat, 16 Mar 2013 21:35:12 +0100 Subject: [PATCH] first README.md --- README.md | 82 ++++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 81 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 64e0d68..11e3c19 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,84 @@ libHttpServer ============= -This is a partly finished implementation of HTTP/1.1. It is especially intendet to write C only REST server, well, at least thats the idea. \ No newline at end of file +This is a partly finished implementation of HTTP/1.1. +It is especially intendet to write C only REST server, +well, at least thats the idea. + +INSTALLATION +------------ + +Currently there is no finished installation process. +Further more, packages are required for building this thing, +that in fact are only requered for the testing part. + +### BUILD REQUIREMENTS + +You need the following to build this thing. + +- A GNU Autobuild (autoconf, automake, etc.) installation. +- GCC as well as binutils. +- lcov (this dependency has to change as it is really only related to testing. + +### BUILDING + +Call ./bootstrap and then run ./configure. +After that run make. After that you will hopefully find a binary called +*taskrambler* under *src/*. +This is a test application for the library. It's name comes from the +first intention what i would like to do with it. Some kind of task management +system. + +### INSTALLING + +Currently i am not sure if this thing will install correctly. You might try +at your own risk. Anyway, no install should be needed to test this thing. + +USAGE +----- + +### RUNNING + +Simply start the executable *src/taskrambler* after successfull build. +Currently this will stay in the foreground and does logging via syslog. + +### PORT + +The server will listen on port 11212 for HTTP requests and on port 11213 +for SSL requerst. + +You can use telnet or simply start a browser and connect on localhost:11212. + +This should show up a very simplistic page. +It should eneable you to start a session, get values from the server +or login. + +### LOGIN + +You can't use the login without changing the code. It implemented using +ldap and currently not configurable. You have to change the configuration +in the code and compile again. + +TESTING +------- + +This comes with an incomplete unit test suite. +You can use *make test* to build and run the existent tests. + +### REQUIREMENTS + +Currently, you need valgrind to build the tests, because some memory checking is done by the way. + +CONTRIBUTION +------------ + +I would really like to see some people possibly interested in this stuff. +I think it contains some really interesting ideas. + +Well, sadly i have to say that this is a spare time project. Documentation +is sparse and Tests too. + +If you like to contribute anyway, make a fork, do you changes and generate +a pull request. + +I will look at these as soon as possible.