Update README.md with current status

Signed-off-by: Gaulthier Gain <gaulthier.gain@uliege.be>
Reviewed-by: Simon Kuenzer <simon.kuenzer@neclab.eu>

diff --git a/README.md b/README.md
index 3d8f0f22c564772a6a1e323b054f6683c17346ad..3ceb4e0359aa35f0aac7d47262c582ce8e0a304e 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,5 +1,30 @@
 musl for Unikraft
 ===================
 
+This first release provides a functional version of musl (compiles and
+links) on Unikraft but some functions are not supported (especially
+the ones related to threads and network). Furthermore, some functions
+can have unexpected behaviour since they use musl internal thread
+support.
+
+## Build
+
+In order to avoid multiple definitions errors, the following libraries
+MUST NOT BE INCLUDED with musl:
+
+* `POSIX-user`
+* `lwip`
+* `pthread-embedded`
+
+## Known Issues
+
+* At this stage, we noticed that there are some issues with buffering
+on stdout. We are currently investigating this issue but a temporary
+fix is to call `fflush()` after each output on the console.
+
+As things stabilize, we will update this file to reflect this.
+
+## Further information
+
 Please refer to the `README.md` as well as the documentation in the `doc/`
 subdirectory of the main unikraft repository.