Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
huinghuang committed Mar 6, 2015
2 parents 8bc0e06 + a8fa952 commit 317e6be
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 7 deletions.
9 changes: 9 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Configuration
/config.log
/oldisim/config.h
/.sconf_temp
/.sconsign.dblite

# Build directories
/debug
/release
17 changes: 10 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,9 @@ $ pkb.py --benchmarks=oldisim --cloud=[GCP|AZURE|AWS|...] ...
Requirements:
* SCons compiler
* C++11 compatible compiler, e.g., g++ v.4.7.3 or later
versions.
* Boost version 1.5.3
versions.
* Boost version 1.53 or higher (included).
* Cereal (included as a submodule).

Install the requirements with:
```
Expand All @@ -32,7 +33,8 @@ libunwind7-dev libevent-dev scons libboost-all-dev

# Build oldisim #

To build oldisimulator, run `scons` in the root directory of the project.
To build oldisimulator, ensure that all submodules are available (`git
submodule update --init`) and run `scons` in the root directory of the project.

If you need to create static libraries, put the following in a new file named
custom.py in the project root:
Expand All @@ -54,9 +56,10 @@ free queues does not require a built libboost.

To speedup compilation, scons supports parallel compilation, e.g. `scons
-j12` to compile with 12 threads in parallel. There are two build modes,
**release** and **debug**. The default build mode is **release**. The build
mode is specified via the **mode** flag, e.g. `scons mode=release`.
The output of the builds will be put into *BUILD_MODE*/
**release** and **debug**. The default build mode is **release**.
**debug** mode may be specified by passing `RELEASE=0` to `scons`, e.g. `scons
RELEASE=0`.
The output of the builds will be put into `<BUILD_MODE>/`

There are several output directories in the build, corresponding to the
different parts of oldisimulator.
Expand Down Expand Up @@ -91,7 +94,7 @@ allocated for LeafNode.

Run the following command:
```
$ $PATH_TO_BINARY/LeafNode
$ $PATH_TO_BINARY/LeafNode
```

### step 2. Start RootNode ###
Expand Down
1 change: 1 addition & 0 deletions SConstruct
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ if env['RELEASE']:
env.Append(CCFLAGS=['-O3', '-DNDEBUG'])
else:
mymode = 'debug'
env.Append(CCFLAGS=['-Wall', '-Wextra'])

#tell the user what we're doing
print '**** Compiling in ' + mymode + ' mode...'
Expand Down

0 comments on commit 317e6be

Please sign in to comment.