Added a README and instructions for buildroot

README.md

@@ -0,0 +1,17 @@
+# WebTerm
+![Screenshot of WebTerm](screenshot.png)
+
+WebTerm is a Terminal emulator that runs in the browser. It uses [v86](https://github.com/copy/v86) to create a virtual linux via WebAssembly and [xterm.js](https://github.com/xtermjs/xterm.js) as the terminal.
+
+## Getting started
+You can try out a hosted of WebTerm at https://minie4.github.io/webterm or clone the repo and serve the files with any webserver.
+
+It takes about 20 seconds to a few minutes to download the ~45mb iso image and boot the system. 
+
+You can copy and paste text with Ctrl+Alt+C and Ctrl+Alt+V because Ctrl+Shift+C is already used by the the debugger.
+
+## How does it work?
+WebTerm uses the [v86](https://github.com/copy/v86) library to boot up a minimal Linux iso via WebAssembly and then attaches an instance of [xterm.js](https://github.com/xtermjs/xterm.js) to the serial port (/dev/ttyS0).
+
+## Customize the Linux ISO
+The Linux system is built via Buildroot. If you want to customize the OS, look at [docs/buildroot.md](docs/buildroot.md)

docs/buildroot.md

@@ -0,0 +1,24 @@
+# Buildroot
+The Linux iso for WebTerm is built using Buildroot. If you want to build a custom iso, you can use the provided config ([buildroot-config](buildroot-config)) and tweak it.
+
+## Building a custom iso
+Fist you need to download Buildroot. To do that, you can just clone the Buildroot GitHub repository to your computer:
+```
+git clone https://github.com/buildroot/buildroot
+cd buildroot
+```
+Then you can copy the [buildroot-config](buildroot-config) file into the buildroot directory and rename it to `.config`
+
+To change the settings for your image, you can use the `menuconfig` option of Buildroot. There you can click trough the menu and change some of the settings.
+```
+make menuconfig
+```
+Dont forget to select the `Save` option if you are done.
+
+If you are done configuring your linux, you can compile it. This will take some time and disk space.
+```
+make
+```
+If the compilation is completed, you find your iso file under `output/images/rootfs.iso9660`. You can rename it to `os.iso` and put it into the images directory of WebTerm.
+
+Tip: You can add `#debug` to the URL of WebTerm to display the screen of the virtual computer and get some debug information.