Skip to content

Commit a0fe945

Browse files
committed
Update documentation.
1 parent 3321474 commit a0fe945

File tree

1 file changed

+7
-58
lines changed

1 file changed

+7
-58
lines changed

README.md

Lines changed: 7 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -7,73 +7,22 @@ Its commandline syntax is simply this:
77
Internally, we use Leprechaun to run our JavaScript unit tests. The way this works is that we run a small JavaScript script which opens a new browser frame, attaches some hooks to listen for error conditions and console messages, and points it at the test.
88

99
# Disclaimers
10-
This is very young software. It has a lot of rough edges just now. We think it works, but consider yourself warned.
10+
Leprechaun has a lot of rough edges right now. We've been using it for years, and it works, but consider yourself warned.
1111

1212
# FAQ
1313
### How is Leprechaun different from PhantomJS?
14-
[PhantomJS](http://phantomjs.org/) is built atop QtWebKit, which is about a year and a half behind what you get in Chrome today. It therefore lacks a bunch of useful things, like Float64Array.
1514

16-
It is also a lot less mature than PhantomJS. If stability is more important than the latest browser features, PhantomJS is terrific.
15+
The long and the short of it is that we need WebGL, which the PhantomJS team are not interested in implementing.
1716

18-
Leprechaun (as of this writing) embeds Chrome 43.0.2357.81 via the thoroughly excellent [CEF](https://bitbucket.org/chromiumembedded/cef). Leprechaun supports everything that modern Chrome supports.
17+
If you don't need WebGL and you'd rather use something that is under active development, give [PhantomJS](http://phantomjs.org/) a try. It's pretty great.
18+
19+
Leprechaun (as of this writing) embeds Chrome 56.0.2924.76 via the thoroughly excellent [CEF](https://bitbucket.org/chromiumembedded/cef). Leprechaun supports everything that modern Chrome supports.
1920

2021
---
2122

2223
# Compiling
23-
Leprechaun has been tested to build on Linux Ubuntu Precise (12.04), Windows 7, and OSX 10.9. No other configurations have been tested.
24-
25-
First, download the appropriate [compiled CEF binary](http://opensource.spotify.com/cefbuilds/index.html) or [build CEF from source](https://bitbucket.org/chromiumembedded/cef/wiki/BranchesAndBuilding) using the automated build process. We are using Branch 2357. Building Leprechaun on Linux Ubuntu Precise cannot use the pre-built CEF binaries because of an incompatibility with the default libstdc++ package.
26-
* Linux 64bit CEF 3.2357.1276
27-
* Mac 64bit CEF 3.2357.1276
28-
* Windows 32bit CEF 3.2357.1280
29-
30-
If building CEF from source (requires ~24GB of space):
31-
32-
wget https://bitbucket.org/chromiumembedded/cef/raw/master/tools/automate/automate-git.py
33-
python automate-git.py --download-dir=<some_temp_location> --branch=2357 --no-debug-build
34-
cp -r <some_temp_location>/chromium/src/cef/binary_distrib/cef_binary_3.2357.1280.<some_hash>.linux64/ <somewhere>
35-
36-
Otherwise, unpack the pre-built CEF binary:
37-
38-
cd <somewhere>
39-
p7zip -d /path/to/cef/download.7z
40-
41-
Install cmake 3.x
42-
43-
wget http://www.cmake.org/files/v3.2/cmake-3.2.3.tar.gz
44-
tar -xf cmake-3.2.3.tar.gz
45-
cd cmake-3.2.3/
46-
./bootstrap
47-
make
48-
sudo make install
49-
50-
Install depot\_tools
51-
52-
sudo apt-get install depot_tools
53-
54-
Build the pre-built CEF binary (yes, the pre-built CEF binaries need to be built)
55-
56-
cd <somewhere>/cef_binary_3.2357.1280_<some_hash>/
57-
mkdir build
58-
cd build
59-
cmake -DCMAKE_BUILD_TYPE=Release ..
60-
ninja cefclient cefsimple
61-
62-
Install SCons
63-
64-
sudo apt-get install scons
65-
66-
Get Leprechaun
67-
68-
cd <somewhere>
69-
git clone [email protected]:imvu/leprechaun.git
70-
cd leprechaun
71-
72-
Run SCons in the leprechaun source directory to compile.
73-
74-
scons CEFDIR=/path/to/extracted/cef
7524

76-
More up-to-date compiling hints can be found in [COMPILING](COMPILING.md)
25+
Instructions in [COMPILING](COMPILING.md)
7726

7827
# How it Works
7928

@@ -98,4 +47,4 @@ test.js works by listening to the Chromium debugger by opening a websocket to lo
9847
# Future improvements
9948
* Update the "Major Moving Parts" section to make it reflect the current state of the project
10049
* Make interface compatible with PhantomJS
101-
* Make chromium operate in headless mode to remove runtime dependence on Xvfb or X
50+
* Make Chromium operate in headless mode to remove runtime dependence on Xvfb or X

0 commit comments

Comments
 (0)