From: Andrei Tatar Date: Mon, 7 Aug 2023 19:36:29 +0000 (+0200) Subject: Update README & CONTRIBUTING X-Git-Tag: RELEASE-0.14.0 X-Git-Url: http://xenbits.xensource.com/gitweb?a=commitdiff_plain;h=dc32aac0511a13f4a0f18b8068d52290936abefb;p=unikraft%2Flibs%2Fgoogletest.git 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 Reviewed-by: Maria Sfiraiala Approved-by: Razvan Deaconescu Tested-by: Unikraft CI GitHub-Closes: #2 --- diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5f55eca..523a060 100644 --- 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 d0344ef..e4dbef9 100644 --- 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.