Re: [Minios-devel] [UNIKRAFT PATCH] README.md: update to match current state of project.

[Simon Kuenzer <simon.kuenzer@xxxxxxxxx>]

Thanks!

Reviewed-by: Simon Kuenzer <simon.kuenzer@xxxxxxxxx>

On 17.02.20 14:24, Felipe Huici wrote:
> Update README.md to include links to the project's new website as well
> as to the new kraft tool.
>
> Signed-off-by: Felipe Huici <felipe.huici@xxxxxxxxx>
> ---
>   README.md | 46 +++++++++++++---------------------------------
>   1 file changed, 13 insertions(+), 33 deletions(-)
>
> diff --git a/README.md b/README.md
> index 4459bca..408af70 100644
> --- a/README.md
> +++ b/README.md
> @@ -1,5 +1,4 @@
> -Unikraft - "Unikernel Crafting"
> -==============================
> +# Unikraft - Unleash the Power of Unikernels
>   
>   Unikraft is an automated system for building specialized OSes and
>   unikernels tailored to the needs of specific applications. It is based
> @@ -8,44 +7,25 @@ of the functionality commonly found in an operating system 
> (e.g.,
>   memory allocation, scheduling, filesystem support, network stack,
>   etc.).
>   
> -In addition, Unikraft has the concept of external libraries. These are
> -what we commonly understand as standard libraries such as libc or
> -openssl, and help to enhance the functionality of Unikraft and the
> -range of applications it is able to support.
> -
>   Unikraft supports multiple target platforms (e.g., Xen, KVM and Linux
>   userspace for development purposes), so that it is possible to build
>   multiple images, one for each platform, for a single application
>   *without* requiring the application developer to do any additional,
> -platform-specific work.
> +platform-specific work. In all, Unikraft is able to build specialized
> +OSes and unikernels targeted at specific applications without
> +requiring the time-consuming, expert work that is required today to
> +build such images.
>   
> -The configuration and build process are driven by a menu system
> -inspired by Linux's kConfig system, making it easy to choose different
> -libraries and configure them. This simplifies the process of trying
> -out different configurations in order to extract the best possible
> -performance out of a particular application.
> +## Getting Started
> +The easiest way to get started with Unikraft is to follow the
> +[instructions](http://www.unikraft.org/getting-started.md) on our website's 
> getting started page.
>   
> -In all, Unikraft is able to build specialized OSes and unikernels
> -targeted at specific applications without requiring the
> -time-consuming, expert work that is required today to build such
> -images.
> +## Contributing
> +If you're interested in contributing please take a look at the list of [open 
> projects](https://github.com/unikraft/unikraft/issues?q=is%3Aissue+is%3Aopen+label%3Aproject).
>  If one of these interests you please drop us a line via the [mailing 
> list](https://lists.xenproject.org/cgi-bin/mailman/listinfo/minios-devel) or 
> directly at unikraft@xxxxxxxxxxxxxxxxxx .
>   
> +## Further Resources
>   For more information information about Unikraft, including user and
>   developer guides, please refer to the `docs/guides` directory or point
>   your browser to the Unikraft
> -[documentation](http://docs.unikraft.org/)
> -
> -Contributing
> ------------------
> -
> -If you're interested in contributing please take a look at the list of
> -[open projects](https://github.com/unikraft/unikraft/issues). If one
> -of these interests you please drop us a line via the mailing list or
> -directly at unikraft@xxxxxxxxxxxxxxxxxx .
> -
> -Further Resources
> ------------------
> -* [Unikraft Core 
> Team](https://www.xenproject.org/developers/teams/unikraft.html)
> -* [Mailing List 
> Archive](https://lists.xenproject.org/archives/html/minios-devel)
> -* [Mailing List Subscription](mailto:minios-devel-request@xxxxxxxxxxxxxxxxxxxx)
> -* [Patchwork](https://patchwork.unikraft.org/project/unikraft/list/)
> +[documentation](http://docs.unikraft.org/). Further resources can be
> +found on the project's [website](http://www.unikraft.org/) .
_______________________________________________
Minios-devel mailing list
Minios-devel@xxxxxxxxxxxxxxxxxxxx
https://lists.xenproject.org/mailman/listinfo/minios-devel