Skip to content

Commit c641c72

Browse files
authored
Merge pull request #1470 from hioa-cs/master
Merge master into dev
2 parents 3a5e9d8 + 21da45f commit c641c72

1 file changed

Lines changed: 14 additions & 13 deletions

File tree

README.md

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,6 @@
11
![IncludeOS Logo](./doc/logo.png)
22
================================================
33

4-
**Update**: Check out [Acorn](examples/acorn/), the innovative web server appliance we [demoed at CppCon](https://www.youtube.com/watch?v=t4etEwG2_LY). Built using [Mana](lib/mana/), the new C++ Web Application Framework for IncludeOS.
5-
6-
A *live demo* of Acorn can be found at [acorn2.unofficial.includeos.io](http://acorn2.unofficial.includeos.io) (sporadically unavailable)
7-
84
**IncludeOS** is an includable, minimal [unikernel](https://en.wikipedia.org/wiki/Unikernel) operating system for C++ services running in the cloud. Starting a program with `#include <os>` will literally include a tiny operating system into your service during link-time.
95

106
The build system will:
@@ -48,22 +44,22 @@ A longer list of features and limitations is on the [wiki feature list](https://
4844

4945
By default the project is installed to /usr/local/includeos.
5046

51-
However, it is recommended to choose a custom location as well as select the compiler we want clang to find.
47+
However, it is recommended to choose a custom location as well as select the compiler we want clang to find. In this document we assume you install IncludeOS in your home directory, in the folder ~/includeos.
5248

53-
To do this we can edit ~/.bashrc (in the home folder), adding these lines at the end of the file:
49+
To do this we can edit ~/.bash_profile (mac os) or ~/.bashrc (linux), adding these lines at the end of the file:
5450

5551
```
56-
export CC=/usr/bin/clang-3.8
57-
export CXX=/usr/bin/clang++-3.8
58-
export INCLUDEOS_PREFIX=<HOME FOLDER>/includeos
52+
export INCLUDEOS_PREFIX=~/includeos/
5953
export PATH=$PATH:$INCLUDEOS_PREFIX/bin
6054
```
6155

6256
This will also crucially make the boot program visible globally, so that you can simply run ```boot <myservice>``` inside any service folder.
6357

6458
### Install libraries
6559

66-
**NOTE:** The script will install packages and create a network bridge.
60+
If you want to install IncludeOS on Mac OS you'll need a working installation of [brew] so the install script can install its dependencies.
61+
62+
**NOTE:** The script will install packages.
6763

6864
```
6965
$ git clone https://github.com/hioa-cs/IncludeOS
@@ -85,13 +81,14 @@ Configuration of your IncludeOS installation can be done inside `build/` with `c
8581

8682
### Testing the installation
8783

88-
A successful setup enables you to build and run a virtual machine. Running:
84+
A successful setup enables you to build and run a virtual machine. There are a few demonstration services in the source folder. If you look in the `examples/` folder you see these. If you enter `demo_service` and type `boot --create-bridge .` this script will build the service and boot it using [qemu].
8985

9086
```
91-
$ ./test.sh
87+
$ cd examples/demo_service
88+
$ boot --create-bridge .
9289
```
9390

94-
will build and run [this example service](./examples/demo_service/service.cpp).
91+
will build and run [this example service](./examples/demo_service/service.cpp). You can visit the service on [http://10.0.0.42/](http://10.0.0.42/).
9592

9693
More information is [available on the wiki](https://github.com/hioa-cs/IncludeOS/wiki/Testing-the-example-service).
9794

@@ -130,3 +127,7 @@ We want to adhere as much as possible to the [ISO C++ Core Guidelines](https://g
130127
We're trying to grow a Wiki, and some questions might already be answered here in the [FAQ](https://github.com/hioa-cs/IncludeOS/wiki/FAQ).
131128

132129
See the [Wiki front page](https://github.com/hioa-cs/IncludeOS/wiki) for a complete introduction, system overview, and more detailed guides.
130+
131+
132+
[brew]: https://brew.sh/
133+
[qemu]: https://www.qemu.org/

0 commit comments

Comments
 (0)