doc: README updates
Make it more clear on how to build and run the programs.
Change-Id: I5d35b797ac98ca6071f251ea0ca37fe057478697
Signed-off-by: Chris Smart <chris@distroguy.com>
Signed-off-by: Joel Stanley <joel@jms.id.au>
diff --git a/README.md b/README.md
index 5318177..24f3786 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,32 @@
## To Build
-```
-To build this package, do the following steps:
+Note: In addition to a toolchain and autoconf tools, this requires `autotools-archive` to be installed.
- 1. ./bootstrap.sh
- 2. ./configure ${CONFIGURE_FLAGS}
- 3. make
+To build this project, run the following shell commands:
-To full clean the repository again run `./bootstrap.sh clean`.
```
+./bootstrap.sh
+./configure ${CONFIGURE_FLAGS}
+make
+```
+
+To fully clean the repository, run:
+```
+./bootstrap.sh clean
+```
+
+## To Run Server
+Running the server requires a serial port (e.g. /dev/ttyS0):
+
+```
+touch obmc-console.conf
+./obmc-console-server --config obmc-console.conf ttyS0
+```
+
+## To Connect Client
+To connect to the server, simply run the client:
+
+```
+./obmc-console-client
+```
+
+To disconnect the client, use the standard `~.` combination.