Skip to content

Commit 915e224

Browse files
authored
Merge pull request travitch#53 from delcypher/improve_docs
Improve docs
2 parents 1345784 + ab8e810 commit 915e224

File tree

1 file changed

+25
-7
lines changed

1 file changed

+25
-7
lines changed

README.md

Lines changed: 25 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
![WLLVM](https://github.com/SRI-CSL/whole-program-llvm/blob/master/img/dragon128x128.png?raw_true)Whole Program LLVM
1+
![WLLVM](img/dragon128x128.png?raw_true)Whole Program LLVM
22
==================
33
[![PyPI version](https://badge.fury.io/py/wllvm.svg)](https://badge.fury.io/py/wllvm)
44
[![Build Status](https://travis-ci.org/SRI-CSL/whole-program-llvm.svg?branch=master)](https://travis-ci.org/SRI-CSL/whole-program-llvm)
@@ -51,9 +51,27 @@ Tutorial
5151
=======
5252
If you want to develop or use the development version:
5353

54-
git clone https://github.com/SRI-CSL/whole-program-llvm
55-
cd whole-program-llvm
56-
pip install -e .
54+
```
55+
git clone https://github.com/travitch/whole-program-llvm
56+
cd whole-program-llvm
57+
```
58+
59+
Now you need to install WLLVM. You can either install
60+
globally on your system in develop mode:
61+
62+
```
63+
sudo pip install -e .
64+
```
65+
66+
or install WLLVM into a virtual python environment
67+
in develop mode to avoid installing globally:
68+
69+
```
70+
virtualenv venv
71+
source venv/bin/activate
72+
pip install -e .
73+
```
74+
5775

5876

5977
Usage
@@ -126,7 +144,7 @@ Tutorials
126144
---------
127145

128146
A gentler set of instructions on building apache in a vagrant Ubuntu 14.04 can be found
129-
[here,](https://github.com/SRI-CSL/whole-program-llvm/blob/master/doc/tutorial.md) and for Ubuntu 16.04 [here.](https://github.com/SRI-CSL/whole-program-llvm/blob/master/doc/tutorial-ubuntu-16.04.md)
147+
[here,](doc/tutorial.md) and for Ubuntu 16.04 [here.](doc/tutorial-ubuntu-16.04.md)
130148

131149
Building a bitcode module with dragonegg
132150
----------------------------------------
@@ -173,7 +191,7 @@ Building an Operating System
173191
----------------------------
174192

175193
To see how to build freeBSD 10.0 from scratch check out this
176-
[guide.](https://github.com/SRI-CSL/whole-program-llvm/blob/master/doc/tutorial-freeBSD.md)
194+
[guide.](doc/tutorial-freeBSD.md)
177195

178196

179197
Configuring without building bitcode
@@ -239,4 +257,4 @@ it might point out what is wrong.
239257
License
240258
-------
241259

242-
WLLVM is released under the MIT license. See the file `LICENSE` for [details.](https://github.com/SRI-CSL/whole-program-llvm/blob/master/LICENSE)
260+
WLLVM is released under the MIT license. See the file `LICENSE` for [details.](LICENSE)

0 commit comments

Comments
 (0)