Merge pull request #725 from morphis/update-readme

Update README with link to our current installation instructions
This commit is contained in:
Simon Fels 2018-05-26 18:28:57 +02:00 committed by GitHub
commit a88faed6d3
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -39,50 +39,7 @@ The used image is currently based on Android 7.1.1
## Installation
The installation process currently consists of a few steps which will
add additional components to your host system. These include
* Out-of-tree kernel modules for binder and ashmem as no distribution kernel
ships both enabled.
* A udev rule to set correct permissions for /dev/binder and /dev/ashmem
* A upstart job which starts the Anbox session manager as part of
a user session.
To make this process as easy as possible we have bundled the necessary
steps in a snap (see https://snapcraft.io) called "anbox-installer". The
installer will perform all necessary steps. You can install it on a system
providing support for snaps by running
```
$ snap install --classic anbox-installer
```
Alternatively you can fetch the installer script via
```
$ wget https://raw.githubusercontent.com/anbox/anbox-installer/master/installer.sh -O anbox-installer
```
Please note that we don't support any possible Linux distribution out there
yet. Please have a look at the following chapter to see a list of supported
distributions.
To proceed the installation process simply called
```
$ anbox-installer
```
This will guide you through the installation process.
**NOTE:** Anbox is currently in a **alpha development state**. Don't expect a
fully working system for a production system with all features you need. You will
for sure see bugs and crashes. If you do so, please don't hestitate and report them!
**NOTE:** The Anbox snap currently comes **completely unconfined** and is because of
this only available from the edge channel. Proper confinement is a thing we want
to achieve in the future but due to the nature and complexity of Anbox this isn't
a simple task.
See our [installation instructions](docs/install.md) for details.
## Supported Linux Distributions
@ -96,6 +53,8 @@ well as long as they provide the mandatory kernel modules (see kernel/).
## Install and Run Android Applications
TBD
## Build from source
### Requirements