Go to file
Lucas Ramage d37d901ce4 Remove auto-generated files
Bug: https://github.com/proot-me/proot/issues/198
2019-12-18 18:12:33 +00:00
contrib Add CARE utility scripts 2019-04-18 19:11:18 -04:00
doc Remove auto-generated files 2019-12-18 18:12:33 +00:00
src Remove auto-generated files 2019-12-18 18:12:33 +00:00
tests Fix permissions for certain tests 2019-05-09 20:05:34 -04:00
.gitignore Remove auto-generated files 2019-12-18 18:12:33 +00:00
.gitlab-ci.yml Auto-deploy to GitHub Pages 2019-12-14 13:48:41 -05:00
.mailmap Create .mailmap 2019-03-11 08:45:36 -04:00
.travis.yml Fix CI/CD pipelines 2019-12-14 08:05:05 -05:00
AUTHORS Prepare release v3.2.2. 2013-11-29 11:19:11 +01: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 [skip ci] Fix typo 2019-12-17 12:33:07 -05: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.exe loader-m32.exe build.h # first build the config and loader
    make -C src proot care # then compile PRoot and CARE
    make -C tests # run test suite

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>`_