folkslinux
/
proot
mirror of https://github.com/proot-me/proot.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
1,184 Commits 9 Branches 77 Tags 5.2 MiB
C 88.4%
Shell 8.3%
Makefile 2.3%
Python 0.4%
SWIG 0.3%
Other 0.3%
Go to file
Lucas Ramage a4db64532f Prepare documentation for release 2020-04-14 19:12:16 +00:00
contrib Add CARE utility scripts 2019-04-18 19:11:18 -04:00
doc Prepare documentation for release 2020-04-14 19:12:16 +00:00
src Prepare documentation for release 2020-04-14 19:12:16 +00:00
test Limit testsuite to five minutes 2020-04-02 17:40:12 +00:00
util Update site.sh 2020-02-27 08:26:40 -05:00
.gitignore Prepare documentation for release 2020-04-14 19:12:16 +00:00
.gitlab-ci.yml Limit testsuite to five minutes 2020-04-02 17:40:12 +00:00
.mailmap Create .mailmap 2019-03-11 08:45:36 -04:00
.travis.yml Limit testsuite to five minutes 2020-04-02 17:40:12 +00:00
AUTHORS Prepare documentation for release 2020-04-14 19:12:16 +00:00
CHANGELOG.rst Prepare documentation for release 2020-04-14 19:12:16 +00:00
COPYING Add a copy of PRoot's license. 2011-11-07 08:37:28 +01:00
HACKING.rst Add contributing guide 2019-04-06 13:30:54 +00:00
ISSUE_TEMPLATE Add contributing guide 2019-04-06 13:30:54 +00:00
README.rst Collapse badges 2020-04-10 22:11:13 -04:00

README.rst 

PRoot
=====

*chroot, mount --bind, and binfmt_misc without privilege/setup for Linux*

Build status
============

.. image:: https://img.shields.io/gitlab/pipeline/proot/proot.svg?label=gitlab-ci&style=flat-square
   :target: https://gitlab.com/proot/proot/pipelines

.. image:: https://img.shields.io/travis/proot-me/proot.svg?label=travis-ci&style=flat-square
   :target: https://travis-ci.org/proot-me/proot

.. image:: https://img.shields.io/badge/scan--build-latest-yellow.svg?style=flat-square
   :target: https://proot.gitlab.io/proot/reports/scan-build

.. image:: https://img.shields.io/badge/lcov-latest-6688D4.svg?style=flat-square
   :target: https://proot.gitlab.io/proot/reports/lcov

Compiling
=========

The following commands can be used to compile PRoot and CARE::

    make -C src loader.elf loader-m32.elf build.h # first build the config and loader
    make -C src proot care # then compile PRoot and CARE
    make -C test # run test suite

|asciicast|

.. |asciicast| image:: https://asciinema.org/a/315367.svg
   :target: https://asciinema.org/a/315367

Dependencies
============

- `libarchive <https://libarchive.org>`_
- `libtalloc <https://talloc.samba.org>`_
- `uthash <https://troydhanson.github.io/uthash>`_

Manuals
=======

- `PRoot <https://raw.githubusercontent.com/proot-me/proot/master/doc/proot/manual.txt>`_

- `CARE <https://raw.githubusercontent.com/proot-me/proot/master/doc/care/manual.txt>`_

Support
=======

- `Mailing List <mailto:proot_me@googlegroups.com>`_
- `Forum <https://groups.google.com/forum/?fromgroups#!forum/proot_me>`_
- `Chat <https://gitter.im/proot-me/devs>`_

License
=======

SPDX-License-Identifier: `GPL-2.0-or-later <COPYING>`_