Update README & CONTRIBUTING

Reformat to Markdown.
CONTRIBUTING: remove obsolete references, point users at website
README: add a short description

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

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 ec8c4743b33ab29e917a0fa84ef8d8157c967fd9..616870ec3366a2b69a805d02a7808dd8eb0619ff 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,5 +1,7 @@
-libintel\_intriniscs for Unikraft
-===================
+# Intel (x86) intrinsics for Unikraft
 
-Please refer to the `README.md` as well as the documentation in the `doc/`
-subdirectory of the main unikraft repository.
+This is a port of the headers providing compiler intrinsics for x86 architectures.
+A list of these intrinsics can be browsed at [Intel Intrinsics](https://www.intel.com/content/www/us/en/docs/intrinsics-guide/index.html).
+Normally you would receive these headers together with your compiler, however, due to Unikraft's isolated build environment, we provide them explicitly.
+
+Please refer to `README.md` in the main unikraft repository as well as the [Unikraft Homepage](https://unikraft.org/) for further information.