added a bunch of docs for FRequest

FRequest/FRequest-protocol.md

@@ -37,3 +37,7 @@ Status codes can be the following characters:
 4. The server closes the connection when the transfer is completed.
 
 Servers may wish to implement restricting users to a specific directory.
+
+## Implementations
+
+- [OpenOS reference implementation](OpenOS/README.md)

FRequest/OpenOS/README.md

@@ -0,0 +1,55 @@
+# Minitel for OpenOS
+
+This package includes the FRequest daemon, in etc/rc.d/frequest.lua, and the fget FRequest client, in usr/bin/fget.lua.
+
+## fget client
+
+### Installation
+
+#### With OPPM
+
+1. Run `oppm install fget`
+
+#### Manual
+
+1. Place fget.lua into /usr/bin
+
+### Invocation
+
+fget can be used to get both directory listings and files, provided the server allows it.
+
+To use fget, run:
+
+```
+fget <host[:port]> <path>
+```
+
+## fserv daemon
+
+fserv is the FRequest server. It provides directory listing and file transfer.
+
+### Installation
+
+#### With OPPM
+
+1. Run `oppm install frequestd`
+
+#### Manual
+
+1. Place fserv.lua into /etc/rc.d
+2. Run rc frequestd enable; rc minitel start
+
+### Configuration
+
+The fserv daemon does not keep a configuration file, so settings have to be set every boot.
+
+To change a setting, one invokes:
+
+`rc fserv set_<option> value`
+
+#### Available settings
+
+- port: the minitel port the FRequest server runs on
+- path: the root path of the server
+
+In addition, one can invoke *rc fserv debug* to get large amounts of debug output.

README.md

@@ -20,7 +20,8 @@ Minitel aims to implement layers 3, 4 and 5 of the OSI model.
 ## Application-layer protocols
 This repository also contains a number of implementations and specifications for application-layer protocols using Minitel.
 
-- [FRequest](FRequest/FRequest-protocol.md)
+- [FRequest](FRequest/README.md)
+- [Minitel Mail](MMail/README.md)
 
 ## Development and discussion
 Code and documentation is hosted in the [Github repository](https://github.com/XeonSquared/OC-Minitel).