Hiddenden/beef
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update documentation

Browse Source
This commit is contained in:
Brendan Coles
2019-02-10 10:53:03 +00:00
parent f48acc3708
commit c4a324c80f
2 changed files with 13 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@@ -36,12 +36,13 @@ __Twitter:__ @beefproject
Requirements
------------
* Operating System: Mac OSX 10.5.0 or higher / modern Linux
* [Ruby](http://ruby-lang.org): 2.3 or newer
* Operating System: Mac OSX 10.5.0 or higher / modern Linux. Note: Windows is not supported.
* [Ruby](http://ruby-lang.org): 2.4 or newer
* [SQLite](http://sqlite.org): 3.x
* [Node.js](https://nodejs.org): 6 or newer
* The gems listed in the Gemfile: https://github.com/beefproject/beef/blob/master/Gemfile
* brew install selenium-server-standalone (See https://github.com/shvets/selenium)
* Selenium is required on OSX: brew install selenium-server-standalone (See https://github.com/shvets/selenium)
Quick Start
-----------
@@ -50,7 +51,9 @@ __The following is for the impatient.__
The `install` script installs the required operating system packages and all the prerequisite Ruby gems:
$ ./install
```
$ ./install
```
For full installation details, please refer to [INSTALL.txt](https://github.com/beefproject/beef/blob/master/INSTALL.txt).
@@ -64,4 +67,6 @@ Usage
To get started, simply execute beef and follow the instructions:
$ ./beef
```
$ ./beef
```