Update README & CONTRIBUTING

Reformat to Markdowm.
CONTRIBUTING: remove obsolete references, point users at unikraft website
README: clean up & simplify wording, point users at website

Signed-off-by: Andrei Tatar <andrei@unikraft.io>
Reviewed-by: Maria Sfiraiala <maria.sfiraiala@gmail.com>
Approved-by: Razvan Deaconescu <razvand@unikraft.io>
Tested-by: Unikraft CI <monkey@unikraft.io>
GitHub-Closes: #2

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 5f55eca6d9a2ca5128a67d84929c49d02384dd3f..523a060b3a717a91a8c80498d937d169ef4280d1 100644 (file)
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,4 +1,4 @@
-Contributing to Unikraft
-=======================
+# Contributing to Unikraft
 
-Please refer to the `CONTRIBUTING.md` file in the main Unikraft repository.
+Contributions to Unikraft are welcome!
+Please refer to the [Contributing](https://unikraft.org/docs/contributing/) page for further information.

diff --git a/README.md b/README.md
index d0344ef5e309cbac7f4e9ac20a91d277412e7988..e4dbef95799a78b7c4fa09fa1da41d084a301802 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,19 +1,12 @@
-googletest for Unikraft
-===================
+# GoogleTest for Unikraft
 
-This is the port of googletest to Unikraft as an external
-library. libcxx is required. This library should come at the end of
-the dependency list, e.g.,:
+This is the port of [GoogleTest](https://google.github.io/googletest/) to Unikraft.
 
-       ...:$(UK_LIBS)/libunwind:$(UK_LIBS)/compiler-rt:$(UK_LIBS)/libcxxabi:
-        $(UK_LIBS)/libcxx:$(UK_LIBS)/newlib:$(UK_LIBS)/googletest:...
-                                        
-This library has a config option called LIBGOOGLETEST_BUILD_MAIN that
-builds the gtest_main.cc file. This is because some libraries do not
-have any main function in their unit tests and expect googletest to
-provide it.
+Some libraries that use GoogleTest rely on it to also provide a boilerplate main function to run their tests.
+Providing this function by default might however conflict with the application's intended main.
+For this purpose the LIBGOOGLETEST_BUILD_MAIN config option controls whether GoogleTest provides a `main()` function.
                                                                 
-Please refer to the `README.md` as well as the documentation in the
-`doc/` subdirectory of the main unikraft repository for further
-information.
+GoogleTest being a C++ library, `libcxx` is required.
+`lib-googletest` should come at the end of the dependency list.
 
+Please refer to `README.md` in the main unikraft repository as well as the [Unikraft Homepage](https://unikraft.org/) for further information.