From: Michal Sojka <michal.sojka@cvut.cz>
Date: Tue, 26 Jan 2021 11:08:46 +0000 (+0100)
Subject: Add README.md
X-Git-Tag: 20210126a~9
X-Git-Url: https://rtime.felk.cvut.cz/gitweb/novaboot.git/commitdiff_plain/e9400a4acd8ee56ed318752d51efabc663fd290b

Add README.md

It is shorter than the current README.pod (man page), to which it
links. In addition to the man page, it contains installation
instructions and links to server-side documentation.
---

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..bcd88d1
--- /dev/null
+++ b/README.md
@@ -0,0 +1,43 @@
+# Novaboot
+
+Novaboot is a tool that automates booting of operating systems on
+target hardware (typically embedded boards) or in Qemu. Initially, it
+was developed to boot [NOVA Microhypervisor](http://hypervisor.org/)
+(hence the name), but nowadays is well suited for booting
+[Linux](https://www.kernel.org/) (and perhaps other OSes) too.
+
+## Instalation
+
+The simplest way to install novaboot is to install `perl` and its
+packages `IO-Stty` and `Expect` and copy the
+[novaboot](server/novaboot-shell.pod) script somewhere to your $PATH.
+
+You can also install everything (including man pages) by:
+
+    make install
+
+To install the optional server part (see below), run:
+
+    make -C server install
+
+## Documentation
+
+Novaboot can be used in variety of setups. Most typical ones are
+depicted in the figure below.
+
+![Possible novaboot setups](doc/typical-setups.svg?raw=true "Title")
+
+The setups are fully described in the [documentation](./README.pod),
+but in short: Setup A is for power users, who can configure everything
+themselves, whereas setup C is useful for students, who just want to
+access the target device with as little configuration on their side as
+possible.
+
+### Client side
+
+- novaboot [documentation](./README.pod)
+
+### Server-side (optional, needed only by server administrators for setup C)
+
+- [novaboot-shell](server/novaboot-shell.pod)
+- [adduser-novaboot](server/adduser-novaboot.pod)