Skip to content

Commit

Permalink
Update README & CONTRIBUTING
Browse files Browse the repository at this point in the history
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
  • Loading branch information
andreittr authored and unikraft-bot committed Aug 11, 2023
1 parent e992ca3 commit dc32aac
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 18 deletions.
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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.
23 changes: 8 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit dc32aac

Please sign in to comment.