]> git.proxmox.com Git - mirror_lxc.git/blobdiff - README.md
Merge pull request #4202 from DarkGuySM/master
[mirror_lxc.git] / README.md
index dd03a298b9ae0a6033561a5b4b994db205c66a42..c476e46eb7eb05f6753f8c78f1ae59b07e79ed87 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,14 +1,22 @@
+[![LXD](https://linuxcontainers.org/static/img/containers.png)](https://linuxcontainers.org/lxd)
 # LXC
 
-* Jenkins: [![Build Status](https://jenkins.linuxcontainers.org/job/lxc-github-commit/badge/icon)](https://jenkins.linuxcontainers.org/job/lxc-github-commit/)
-* Travis:  [![Build Status](https://travis-ci.org/lxc/lxc.svg?branch=master)](https://travis-ci.org/lxc/lxc/)
-
 LXC is the well-known and heavily tested low-level Linux container runtime. It
 is in active development since 2008 and has proven itself in critical
 production environments world-wide. Some of its core contributors are the same
 people that helped to implement various well-known containerization features
 inside the Linux kernel.
 
+## Status
+Type            | Service               | Status
+---             | ---                   | ---
+CI (Linux)      | GitHub                | [![Build Status](https://github.com/lxc/lxc/actions/workflows/build.yml/badge.svg)](https://github.com/lxc/lxc/actions)
+CI (Linux)      | Jenkins               | [![Build Status](https://jenkins.linuxcontainers.org/job/lxc-github-commit/badge/icon)](https://jenkins.linuxcontainers.org/job/lxc-github-commit/)
+Project status  | CII Best Practices    | [![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/1087/badge)](https://bestpractices.coreinfrastructure.org/projects/1087)
+Code Quality    | LGTM                  | [![Language grade: C/C++](https://img.shields.io/lgtm/grade/cpp/g/lxc/lxc.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/lxc/lxc/context:cpp)
+Fuzzing         | OSS-Fuzz              | [![Fuzzing Status](https://oss-fuzz-build-logs.storage.googleapis.com/badges/lxc.svg)](https://oss-fuzz-build-logs.storage.googleapis.com/index.html#lxc)
+Fuzzing         | CIFuzz                | [![CIFuzz](https://github.com/lxc/lxc/actions/workflows/cifuzz.yml/badge.svg)](https://github.com/lxc/lxc/actions/workflows/cifuzz.yml)
+
 ## System Containers
 
 LXC's main focus is system containers. That is, containers which offer an
@@ -84,8 +92,8 @@ LXC is configured via a simple set of keys. For example,
 
 LXC namespaces configuration keys by using single dots. This means complex
 configuration keys such as `lxc.net.0` expose various subkeys such as
-`lxc.net.0.type`, `lxc.net.0.link`, `lxc.net.0.ipv6`, and others for even
-more fine-grained configuration.
+`lxc.net.0.type`, `lxc.net.0.link`, `lxc.net.0.ipv6.address`, and others for
+even more fine-grained configuration.
 
 LXC is used as the default runtime for [LXD](https://github.com/lxc/lxd),
 a container hypervisor exposing a well-designed and stable REST-api on top of
@@ -100,6 +108,7 @@ features. This includes (but isn't limited to):
 - i686
 - x86_64
 - ppc, ppc64, ppc64le
+- riscv64
 - s390x
 - armvl7, arm64
 
@@ -113,7 +122,7 @@ LXC also supports at least the following C standard libraries:
 
 LXC has always focused on strong backwards compatibility. In fact, the API
 hasn't been broken from release `1.0.0` onwards. Main LXC is currently at
-version `2.*.*`.
+version `4.*.*`.
 
 ## Reporting Security Issues
 
@@ -121,9 +130,9 @@ The LXC project has a good reputation in handling security issues quickly and
 efficiently. If you think you've found a potential security issue, please
 report it by e-mail to all of the following persons:
 
-- serge.hallyn (at) ubuntu (dot) com
+- serge (at) hallyn (dot) com
 - stgraber (at) ubuntu (dot) com
-- christian.brauner (at) ubuntu (dot) com
+- brauner (at) kernel (dot) org
 
 For further details please have a look at
 
@@ -143,9 +152,9 @@ and should also take a look at the [CONTRIBUTING](CONTRIBUTING) file in this
 repo.
 
 If you want to become more active it is usually also a good idea to show up in
-the LXC IRC channel `#lxc-dev` on `Freenode`. We try to do all development out
+the LXC IRC channel [#lxc-dev](https://kiwiirc.com/client/irc.libera.chat/#lxc-dev) on irc.libera.chat. We try to do all development out
 in the open and discussion of new features or bugs is done either in
-appropriate Github issues or on IRC.
+appropriate GitHub issues or on IRC.
 
 When thinking about making security critical contributions or substantial
 changes it is usually a good idea to ping the developers first and ask whether
@@ -160,7 +169,7 @@ versioning](http://semver.org/) scheme.
 
 Source for the latest released version can always be downloaded from
 
-- https://linuxcontainers.org/downloads/
+- https://linuxcontainers.org/lxc/downloads/
 
 You can browse the up to the minute source code and change history online
 
@@ -170,31 +179,25 @@ You can browse the up to the minute source code and change history online
 
 Without considering distribution specific details a simple
 
-    ./autogen.sh && ./configure && make && sudo make install
+    meson setup -Dprefix=/usr build
+    meson compile -C build
 
 is usually sufficient.
 
-In order to test current git master of LXC it is usually a good idea to compile with
-
-    ./autogen.sh && ./configure && make
-
-in a convenient directory and set `LD_LIBRARY_PATH="${BUILD_DIR}"/lxc/src/lxc/.libs`.
-
 ## Getting help
 
 When you find you need help, the LXC projects provides you with several options.
 
 ### Discuss Forum
 
-We maintain an discuss forum at
+We maintain a discuss forum at
 
 - https://discuss.linuxcontainers.org/
 
 where you can get support.
 
 ### IRC
-
-You can find support by joining `#lxcontainers` on `Freenode`.
+You can find us in [#lxc](https://kiwiirc.com/client/irc.libera.chat/#lxc) on irc.libera.chat.
 
 ### Mailing Lists