Skip to content

Commit 942d8dd

Browse files
committed
Update README for v4.0.0-beta.1
Signed-off-by: Mriyam Tamuli <[email protected]>
1 parent 4b74110 commit 942d8dd

File tree

1 file changed

+38
-1
lines changed

1 file changed

+38
-1
lines changed

README.md

Lines changed: 38 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,40 @@
11
# EasyEngine v4
22

3-
[![Build Status](https://travis-ci.org/EasyEngine/easyengine.svg?branch=release%2Fv4)](https://travis-ci.org/EasyEngine/easyengine)
3+
[![Build Status](https://travis-ci.org/EasyEngine/easyengine.svg?branch=master%2Fv4)](https://travis-ci.org/EasyEngine/easyengine)
4+
5+
## Requirements
6+
7+
* Docker
8+
* Docker-Compose
9+
* PHP CLI
10+
* PHP Modules - `curl`, `sqlite3`, `pcntl`
11+
12+
## Installing
13+
14+
### Mac
15+
16+
Once you have verified the requirements exist, download the `easyengine.phar` file using `wget` or `curl` and give it executable permissions:
17+
18+
```bash
19+
wget -O /usr/local/bin/ee https://raw.githubusercontent.com/EasyEngine/easyengine-builds/master/phar/easyengine.phar
20+
chmod +x /usr/local/bin/ee
21+
```
22+
23+
### Linux
24+
25+
For Linux, we have created an installer script which will install all the dependencies for you. We have tested this on Ubuntu 14.04, 16.04, 18.04 and Debian 8.
26+
27+
```bash
28+
wget -qO ee rt.cx/ee4beta && sudo bash ee
29+
```
30+
31+
Even if the script doesn't work for your distribution, you can manually install the dependencies and then run the following commands to install EasyEngine
32+
33+
```bash
34+
wget -O /usr/local/bin/ee https://raw.githubusercontent.com/EasyEngine/easyengine-builds/master/phar/easyengine.phar
35+
chmod +x /usr/local/bin/ee
36+
```
37+
38+
## Usage
39+
40+
EasyEngine will currently only run with root privileges. You can run `ee help` or `ee help site` to get all the details about the various commands and subcommands that you can run.

0 commit comments

Comments
 (0)