Skip to content

Commit 273f11a

Browse files
committed
Document the Ubuntu 20.04 socat bug (unikraft#29) in README.
Signed-off-by: Xiangyi Meng <xymeng16@gmail.com>
1 parent a8ac3e3 commit 273f11a

File tree

1 file changed

+17
-15
lines changed

1 file changed

+17
-15
lines changed

README.md

+17-15
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ install the requirements:
1414

1515
apt-get install -y --no-install-recommends build-essential libncurses-dev libyaml-dev flex git wget socat bison unzip uuid-runtime;
1616

17+
Note: Ubuntu 20.04 users may suffer from issue [#29](https://github.com/unikraft/kraft/issues/29) due to this [bug](https://bugs.launchpad.net/ubuntu/+source/socat/+bug/1883957) of `socat-1.7.3.3`. If you are using Ubuntu 20.04, please make sure to compile and install the latest version of `socat` retrieved from [this page](http://www.dest-unreach.org/socat/download/).
18+
1719
To install `kraft` simply run:
1820

1921
pip3 install git+https://github.com/unikraft/kraft.git@staging
@@ -30,23 +32,23 @@ is by running the following commands:
3032

3133
At present, Unikraft and kraft support the following applications:
3234

33-
* [C "hello world"](https://github.com/unikraft/app-helloworld) (`helloworld`);
34-
* [C "http reply"](https://github.com/unikraft/app-httpreply) (`httpreply`);
35-
* [C++ "hello world"](https://github.com/unikraft/app-helloworld-cpp) (`helloworld-cpp`);
36-
* [Golang](https://github.com/unikraft/app-helloworld-go) (`helloworld-go`);
37-
* [Python 3](https://github.com/unikraft/app-python3) (`python3`);
38-
* [Micropython](https://github.com/unikraft/app-micropython) (`micropython`);
39-
* [Ruby](https://github.com/unikraft/app-ruby) (`ruby`);
40-
* [Lua](https://github.com/unikraft/app-lua) (`lua`);
41-
* [Click Modular Router](https://github.com/unikraft/app-click) (`click`);
42-
* [JavaScript (Duktape)](https://github.com/unikraft/app-duktape) (`duktape`);
43-
* [Web Assembly Micro Runtime (WAMR)](https://github.com/unikraft/app-wamr) (`wamr`);
44-
* [Redis](https://github.com/unikraft/app-redis) (`redis`);
45-
* [Nginx](https://github.com/unikraft/app-nginx) (`nginx`);
46-
* [SQLite](https://github.com/unikraft/app-sqlite) (`sqlite`);
35+
- [C "hello world"](https://github.com/unikraft/app-helloworld) (`helloworld`);
36+
- [C "http reply"](https://github.com/unikraft/app-httpreply) (`httpreply`);
37+
- [C++ "hello world"](https://github.com/unikraft/app-helloworld-cpp) (`helloworld-cpp`);
38+
- [Golang](https://github.com/unikraft/app-helloworld-go) (`helloworld-go`);
39+
- [Python 3](https://github.com/unikraft/app-python3) (`python3`);
40+
- [Micropython](https://github.com/unikraft/app-micropython) (`micropython`);
41+
- [Ruby](https://github.com/unikraft/app-ruby) (`ruby`);
42+
- [Lua](https://github.com/unikraft/app-lua) (`lua`);
43+
- [Click Modular Router](https://github.com/unikraft/app-click) (`click`);
44+
- [JavaScript (Duktape)](https://github.com/unikraft/app-duktape) (`duktape`);
45+
- [Web Assembly Micro Runtime (WAMR)](https://github.com/unikraft/app-wamr) (`wamr`);
46+
- [Redis](https://github.com/unikraft/app-redis) (`redis`);
47+
- [Nginx](https://github.com/unikraft/app-nginx) (`nginx`);
48+
- [SQLite](https://github.com/unikraft/app-sqlite) (`sqlite`);
4749

4850
For more information about that command type `kraft up -h`. For more information
49-
about `kraft` type ```kraft -h``` or read the documentation at
51+
about `kraft` type `kraft -h` or read the documentation at
5052
[Unikraft's website](https://docs.unikraft.org). If you find any problems please
5153
[fill out an issue](https://github.com/unikraft/tools/issues/new/choose). Thank
5254
you!

0 commit comments

Comments
 (0)