OC-Minitel/README.md

# Minitel
An easy-to-implement networking protocol for OpenComputers. Not to be confused with the [French computer network of the same name](https://en.wikipedia.org/wiki/Minitel).

![Minitel ad](img/minitel-ad.jpg)

Minitel aims to implement layers 3, 4 and 5 of the OSI model.


## Layers
![Layer organisation in Minitel](img/minitel-layers.svg)
### Layer 3
[Layer 3](protocol-3.md) implements addressing, meshing and datagram transmission.

### Layer 4
[Layer 4](protocol-4.md) implements ordered message delivery

### Layer 5
[Layer 5](protocol-5.md) implements reliable, ordered, bidirectional streams.

## Implementations
### OpenOS

- [Reference implementation for OpenOS](OpenOS/README.md)

### KittenOS

- [Minitel for KittenOS NEO](KittenOS/README.md)

### Embedded devices

- [Microtel](Embedded/microtel/README.md)

## Application-layer protocols
This repository also contains a number of implementations and specifications for application-layer protocols using Minitel.

- [FRequest](FRequest/FRequest-protocol.md)
- [syslog](syslog/syslog-protocol.md)
- [Minitel Mail](MMail/MMail-protocol.md)

## Development and discussion
Code and documentation is hosted in the [Github repository](https://github.com/XeonSquared/OC-Minitel).

Discussion takes place in, among other places, the [#SKSDev IRC channel on EsperNet](irc://irc.esper.net/#SKSDev) (`irc://irc.esper.net/#SKSDev`) or alternatively, via [webchat](https://webchat.esper.net/?channels=SKSDev) or [XMPP](xmpp:#SKSDev%irc.esper.net@irc.jabberfr.org?join) (`xmpp:#SKSDev%irc.esper.net@irc.jabberfr.org?join`))
import stuff 2018-02-16 00:46:09 +11:00			`# Minitel`
added static route support to the OpenOS implementation 2018-02-16 22:33:08 +11:00			`An easy-to-implement networking protocol for OpenComputers. Not to be confused with the [French computer network of the same name](https://en.wikipedia.org/wiki/Minitel).`
import stuff 2018-02-16 00:46:09 +11:00
maybe made the images work on github 2018-10-20 01:33:48 +11:00			`![Minitel ad](img/minitel-ad.jpg)`
added some diagrams and stuff 2018-10-20 01:30:54 +11:00
nicer readme 2018-02-16 23:55:05 +11:00			`Minitel aims to implement layers 3, 4 and 5 of the OSI model.`

added some diagrams and stuff 2018-10-20 01:30:54 +11:00
moved protocol to protocol-3, changed readme 2018-02-16 21:42:48 +11:00			`## Layers`
hopefully made the layers diagram less obnoxious 2018-10-20 01:40:55 +11:00			`![Layer organisation in Minitel](img/minitel-layers.svg)`
nicer readme 2018-02-16 23:55:05 +11:00			`### Layer 3`
			`[Layer 3](protocol-3.md) implements addressing, meshing and datagram transmission.`

updated the readme 2018-02-17 15:56:19 +11:00			`### Layer 4`
			`[Layer 4](protocol-4.md) implements ordered message delivery`

			`### Layer 5`
			`[Layer 5](protocol-5.md) implements reliable, ordered, bidirectional streams.`

nicer readme 2018-02-16 23:55:05 +11:00			`## Implementations`
			`### OpenOS`
fixed some formatting 2018-03-30 14:50:44 +11:00
added documentation for the OpenOS implementation 2018-02-17 16:15:11 +11:00			`- [Reference implementation for OpenOS](OpenOS/README.md)`
fixed some formatting 2018-03-30 14:50:44 +11:00
added the KittenOS implementation to the readme 2018-04-04 14:40:35 +10:00			`### KittenOS`

			`- [Minitel for KittenOS NEO](KittenOS/README.md)`

added a note about the embedded version to the README 2018-03-30 14:49:30 +11:00			`### Embedded devices`
fixed some formatting 2018-03-30 14:50:44 +11:00
added a note about the embedded version to the README 2018-03-30 14:49:30 +11:00			`- [Microtel](Embedded/microtel/README.md)`
more readme stuff 2018-02-16 23:59:17 +11:00
Mentioned the applictation-layer protocols. 2018-03-08 09:06:26 +11:00			`## Application-layer protocols`
			`This repository also contains a number of implementations and specifications for application-layer protocols using Minitel.`

fixed a link 2018-03-10 16:35:18 +11:00			`- [FRequest](FRequest/FRequest-protocol.md)`
added syslog to the main readme 2018-08-08 09:36:10 +10:00			`- [syslog](syslog/syslog-protocol.md)`
fixed a link 2018-03-10 16:35:18 +11:00			`- [Minitel Mail](MMail/MMail-protocol.md)`
Mentioned the applictation-layer protocols. 2018-03-08 09:06:26 +11:00
more readme stuff 2018-02-16 23:59:17 +11:00			`## Development and discussion`
			`Code and documentation is hosted in the [Github repository](https://github.com/XeonSquared/OC-Minitel).`

more github stupidity 2022-01-06 09:37:55 +11:00			Discussion takes place in, among other places, the [#SKSDev IRC channel on EsperNet](irc://irc.esper.net/#SKSDev) (`irc://irc.esper.net/#SKSDev`) or alternatively, via [webchat](https://webchat.esper.net/?channels=SKSDev) or [XMPP](xmpp:#SKSDev%irc.esper.net@irc.jabberfr.org?join) (`xmpp:#SKSDev%irc.esper.net@irc.jabberfr.org?join`))