|
|
@@ -1,3 +1,34 @@
|
|
|
-# lcmlog
|
|
|
+# lcmlog-server
|
|
|
|
|
|
-Tool for reading and writing the lcm staff logs
|
|
|
+Server side of a tool for reading and writing the lcm staff logs
|
|
|
+The program doen't accept any command line options.
|
|
|
+The first line of the input can be `GET`, `POST` or `UPDATE`.
|
|
|
+
|
|
|
+## The two kind of the logs
|
|
|
+To do
|
|
|
+
|
|
|
+## The authenticsation process
|
|
|
+To do
|
|
|
+
|
|
|
+## The three methods
|
|
|
+### GET
|
|
|
+The `GET` method is used to print all the logs that meet the required criteria.
|
|
|
+The second line of the input is the kind of the log to search for (see below), and it is the only mandatory parameter.
|
|
|
+The third line is the date: only logs whose date contains the searched for date are printed. The format for the date has not been decided yet, so currently any string can be inserted here.
|
|
|
+The fourth line is a list of comma separated tags to search for.
|
|
|
+The fifth line is the name of the user to search for.
|
|
|
+
|
|
|
+### POST
|
|
|
+The `POST` method is used to add a log to the database.
|
|
|
+The second line of the input is the kind (se below).
|
|
|
+The third one is the date.
|
|
|
+The fourth one is a list of comma separated tags.
|
|
|
+The remainder of the file (until EOF is met) is the content of the log.
|
|
|
+
|
|
|
+### UPDATE
|
|
|
+The `UPDATE` method is used to regenerate the internal server database.
|
|
|
+It should only be called if a log file is added by hand, or if some of the log files get renamed or corrupted.
|
|
|
+It assumes that all the log files are correctly formatted.
|
|
|
+
|
|
|
+## The format of the log files
|
|
|
+To do
|
