[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[UNIKRAFT/LIBMEMCACHED PATCH 7/7] README.md: Update with info about building and running



From: gaulthier gain <gaulthier.gain@xxxxxxxxx>

Signed-off-by: gaulthier gain <gaulthier.gain@xxxxxxxxx>
---
 README.md | 24 +++++++++++++++++++++---
 1 file changed, 21 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index 2f27f51..c26514b 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,25 @@
-Memcached for Unikraft
-=============================
-
+# Memcached for Unikraft
 This is the port of Memcached for Unikraft as external library.
 
+## Build
+Memcached depends on the following libraries, that need to be added to
+`Makefile` in this order:
+
+* `pthreads`, e.g. `pthread-embedded`
+* `libc`, e.g. `newlib`
+* `libevent`
+
+Before you proceed to writing your own application, you can use the
+`main()` function provided in the Memcached glue code by enabling it in
+its configuration menu.
+
+## Root filesystem
+
+To import/export data from/to files, it is necessary to have a
+filesystem. The steps for creating and using a filesystem are the
+same as the ones used for
+[nginx](https://github.com/unikraft/lib-nginx/blob/staging/README.md).
+
+## Further information
 Please refer to the `README.md` as well as the documentation in the
 `doc/` subdirectory of the main unikraft repository.
-- 
2.17.1




 


Rackspace

Lists.xenproject.org is hosted with RackSpace, monitoring our
servers 24x7x365 and backed by RackSpace's Fanatical Support®.