Re: [UNIKRAFT/LIBICU PATCH 2/2] Add documentation

[Razvan Deaconescu <razvan.deaconescu@xxxxxxxxx>]

All good.

Reviewed-by: Razvan Deaconescu <razvan.deaconescu@xxxxxxxxx>

On Mon, Nov 16, 2020 at 2:17 PM Felipe Huici <felipe.huici@xxxxxxxxx> wrote:
>
> Signed-off-by: Felipe Huici <felipe.huici@xxxxxxxxx
> ---
>  CODING_STYLE.md |  4 ++++
>  CONTRIBUTING.md |  4 ++++
>  COPYING.md      | 30 ++++++++++++++++++++++++++++++
>  MAINTAINERS.md  | 10 ++++++++++
>  README.md       | 10 ++++++++++
>  5 files changed, 58 insertions(+)
>  create mode 100644 CODING_STYLE.md
>  create mode 100644 CONTRIBUTING.md
>  create mode 100644 COPYING.md
>  create mode 100644 MAINTAINERS.md
>  create mode 100644 README.md
>
> diff --git a/CODING_STYLE.md b/CODING_STYLE.md
> new file mode 100644
> index 0000000..5730041
> --- /dev/null
> +++ b/CODING_STYLE.md
> @@ -0,0 +1,4 @@
> +Coding Style
> +============
> +
> +Please refer to the `CODING_STYLE.md` file in the main Unikraft repository.
> diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
> new file mode 100644
> index 0000000..5f55eca
> --- /dev/null
> +++ b/CONTRIBUTING.md
> @@ -0,0 +1,4 @@
> +Contributing to Unikraft
> +=======================
> +
> +Please refer to the `CONTRIBUTING.md` file in the main Unikraft repository.
> diff --git a/COPYING.md b/COPYING.md
> new file mode 100644
> index 0000000..af378cc
> --- /dev/null
> +++ b/COPYING.md
> @@ -0,0 +1,30 @@
> +License
> +=======
> +
> +Unikraft UCI wrapper
> +-----------------------
> +
> +This repository contains wrapper code to build uci with Unikraft.
> +Each C code file in this repository should declare who is the
> +copyright owner and under which terms and conditions the code is
> +licensed. If such a licence note is missing, the following copyright
> +notice will apply:
> +
> +       Copyright (c) 2019, University Politehnica of Bucharest. All rights
> +       reserved.
> +
> +       This library is free software; you can redistribute it and/or
> +       modify it under the terms of the GNU Lesser General Public
> +       License as published by the Free Software Foundation; either
> +       version 2 of the License, or (at your option) any later version.
> +
> +       This library is distributed in the hope that it will be useful,
> +       but WITHOUT ANY WARRANTY; without even the implied warranty of
> +       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
> +       Lesser General Public License for more details.
> +
> +       You should have received a copy of the GNU Lesser General Public
> +       License along with this library in the file COPYING.LIB;
> +       if not, write to the Free Software Foundation, Inc.,
> +       59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
> +
> diff --git a/MAINTAINERS.md b/MAINTAINERS.md
> new file mode 100644
> index 0000000..8a1ebb0
> --- /dev/null
> +++ b/MAINTAINERS.md
> @@ -0,0 +1,10 @@
> +Maintainers List
> +================
> +
> +For notes on how to read this information, please refer to `MAINTAINERS.md` 
> in
> +the main Unikraft repository.
> +
> +       PROTOBUF-UNIKRAFT
> +       M:      Felipe Huici <felipe.huici@xxxxxxxxx>
> +       L:      minios-devel@xxxxxxxxxxxxx
> +       F: *
> diff --git a/README.md b/README.md
> new file mode 100644
> index 0000000..e7ccff0
> --- /dev/null
> +++ b/README.md
> @@ -0,0 +1,10 @@
> +icu for Unikraft
> +===================
> +
> +This is the port of icu as a Unikraft external library; it depends on
> +the following libraries that need to be added to `Makefile` in this
> +order:
> +
> +* `pthreads`, e.g. `pthread-embedded`
> +* CXX standard library, e.g. `libunwind`, `compiler-rt`, `libcxxabi`, 
> `libcxx`
> +* `libc`, e.g. `newlib`
> --
> 2.20.1
>
>