Commit graph

8 commits

Author SHA1 Message Date
Paul Moore
c626187063 docs: update the README.md with a basic SELinux description
This is to help meet the OpenSSF Best Practices requirements.

Signed-off-by: Paul Moore <paul@paul-moore.com>
Acked-by: Petr Lautrbach <plautrba@redhat.com>
2022-11-07 11:03:39 +01:00
Christian Göttsche
4ffe2dfc78 Replace PCRE with PCRE2 build dependencies
Now that libselinux defaults to PCRE2 and mcstrans has been ported,
update all documentation and scripts.

Signed-off-by: Christian Göttsche <cgzones@googlemail.com>
2021-12-09 11:07:10 -05:00
Nicolas Iooss
60bde947d6 README: update continuous integration badges
The CI now uses GitHub Actions to run tests and the SELinux testsuite in
a virtual machine. Replace the Travis CI badge with the ones for these
workflows.

Fixes: https://github.com/SELinuxProject/selinux/issues/299
Signed-off-by: Nicolas Iooss <nicolas.iooss@m4x.org>
Acked-by: Ondrej Mosnacek <omosnace@redhat.com>
2021-10-04 09:49:46 -04:00
Evgeny Vereshchagin
e45642441f
README: add OSS-Fuzz/CIFuzz badges
It should make it easier to keep track of what's going on there

Signed-off-by: Evgeny Vereshchagin <evvers@ya.ru>
2021-07-13 21:03:30 +02:00
William Roberts
ddcd6d1b73 README: start a section for documenting CFLAGS
Start a section in the README for documenting that custom CFLAGS yields
custom results and that your mileage may vary. The first CFLAG to
document that you likely want to include is -fno-semantic-interposition.

Signed-off-by: William Roberts <william.c.roberts@intel.com>
Acked-by: Stephen Smalley <stephen.smalley.work@gmail.com>
2020-06-18 19:31:08 +02:00
Christian Göttsche
7c73601d54 tree-wide: introduce PYTHON_SETUP_ARGS to customize setup.py calls on Debian
On Debian the `distutils` module is patched, so `get_python_lib()`
returns by default `/usr/lib/python3/dist-packages` (no minor version)

But `setuptools` affecting setup.py is not patched to create the library
directory at `/usr/lib/python3/dist-packages` by default, rather than a
command line argument `--install-layout deb` is added

Add PYTHON_SETUP_ARGS as argument to affected setup.py calls and add a
note in the global README.md

See https://www.debian.org/doc/packaging-manuals/python-policy/packaging_tools.html
Section B.1

Fixes: https://github.com/SELinuxProject/selinux/issues/187

Signed-off-by: Christian Göttsche <cgzones@googlemail.com>
Acked-by: Petr Lautrbach <plautrba@redhat.com>
2020-05-06 16:12:35 +02:00
Nicolas Iooss
e0d4025530 README: add much useful information
* Add SELinux logo
* Add a link to Travis-CI
* Add a link to lore.kernel.org archive
* Document that SELinux is packaged in several distributions, providing
  links to policycoreutils package (this package requires libsemanage,
  libselinux, libsepol, etc. so if it is packaged, most sub-projects
  have to also be)
* Make Fedora install command readable on GitHub without scrolling
  horizontally and update it
* Split installed packaged between the dependencies for the "main"
  libraries and programs, and the bindings

  - The install command line has been tested using a container from
    image fedora:31

* Document Debian dependencies

  - The install command line has been tested using a container from
    image debian:10

* Document running `make test` with `./scripts/env_use_destdir`
* Introduce "macOS" section for instructions specific to macOS.

Signed-off-by: Nicolas Iooss <nicolas.iooss@m4x.org>
2020-05-04 12:31:02 +02:00
Petr Lautrbach
50b1c97231
Convert README to README.md
It should make the document readable for github users.

Fixes: https://github.com/SELinuxProject/selinux/issues/225

Signed-off-by: Petr Lautrbach <plautrba@redhat.com>
2020-04-28 09:27:49 +02:00