Skip to content

Commit 25f8944

Browse files
committed
Main README updates
1 parent a4f7dde commit 25f8944

File tree

1 file changed

+25
-22
lines changed

1 file changed

+25
-22
lines changed

README.md

Lines changed: 25 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ or chat with us on [Freenode](https://freenode.net/faq.shtml#whatwhy) at `#teche
2323
remote server dedicated to this project or by using a virtual machine.
2424
Here's a short example:
2525

26-
```
26+
```bash
2727
# Clone the project, then move into the right directory
2828
$ cd ~/FrameworkBenchmarks/deployment/vagrant-development
2929
# Turn on the VM. Takes at least 20 minutes
@@ -104,42 +104,39 @@ See [here](deployment) for additional details.
104104

105105
**Setting up the `load server`**
106106

107-
```
108-
toolset/run-tests.py --install client --verbose --install-only
107+
```bash
108+
$ toolset/run-tests.py --install client --install-only
109109
```
110110

111111
**Setting up the `database server`**
112112

113-
```
114-
toolset/run-tests.py --install database --verbose --install-only
115-
# We are still working to automate MongoDO. Until this, please run
116-
# this as well (replacing database-ip with your own value)
117-
mongo --host database-ip < config/create.js
113+
```bash
114+
$ toolset/run-tests.py --install database --install-only
118115
```
119116

120117
**Setting up the `app server`**
121118

122119
You can choose to selectively install components by using the
123120
`--test` and `--exclude` flags.
124121

125-
```
122+
```bash
126123
# Install just the software for beego (as an example)
127-
toolset/run-tests.py --install server --test beego --verbose --install-only
124+
$ toolset/run-tests.py --install server --test beego --verbose --install-only
128125

129126
# Install all php software but php-fuel (as another example)
130-
toolset/run-tests.py --install server --test php* --exclude php-fuel --verbose --install-only
127+
$ toolset/run-tests.py --install server --test php* --exclude php-fuel --verbose --install-only
131128

132129
# Install *all* framework software. Expect this to take hours!
133130
# If running on a remote server, use `screen` or `tmux` or `nohup` to
134131
# prevent the installation from being terminated if you are disconnected
135-
toolset/run-tests.py --install server --verbose --install-only
132+
$ toolset/run-tests.py --install server --verbose --install-only
136133
```
137134

138135
## Listing Tests
139136

140137
You can easily list all available tests
141138

142-
```
139+
```bash
143140
$ toolset/run-tests.py --list-tests
144141
activeweb
145142
activeweb-raw
@@ -156,23 +153,23 @@ aspnet-mono-mongodb-raw
156153

157154
There are a number of options that can be specified:
158155

159-
```
156+
```bash
160157
# Run a verification for test beego
161-
toolset/run-tests.py --test beego --mode verify
158+
$ toolset/run-tests.py --test beego --mode verify
162159

163160
# Run the default benchmark for the beego test
164-
toolset/run-tests.py --test beego
161+
$ toolset/run-tests.py --test beego
165162

166163
# Specify which test types are run during benchmark
167-
toolset/run-tests.py --test beego --type json
168-
toolset/run-tests.py --test beego --type db
169-
toolset/run-tests.py --test beego --type fortune
164+
$ toolset/run-tests.py --test beego --type json
165+
$ toolset/run-tests.py --test beego --type db
166+
$ toolset/run-tests.py --test beego --type fortune
170167

171168
# Specify a number of options for how the load is generated
172-
toolset/run-tests.py --test beego --max-concurrency 24 --max-threads 24 --duration 20 --max-queries 200
169+
$ toolset/run-tests.py --test beego --max-concurrency 24 --max-threads 24 --duration 20 --max-queries 200
173170

174171
# Run a tiny benchmark
175-
toolset/run-tests.py --test beego --max-threads 2 --max-concurrency 2
172+
$ toolset/run-tests.py --test beego --max-threads 2 --max-concurrency 2
176173
```
177174

178175
## Finding output logs
@@ -199,7 +196,9 @@ and all changes. These guidelines prevent us from having to give repeated feedba
199196
the same topics:
200197

201198
* **Use specific versions**: If you're updating any software or dependency, please be
202-
specific with the version number. Also, update the appropriate `README` to reflect that change
199+
specific with the version number. Also, update the appropriate `README` to reflect
200+
that change. Don't rely on the package manager to deliver a specific version, apt
201+
consistently returns different versions on Ubuntu 12.04 vs 14.04.
203202
* **Rope in experts**: If you're making a performance tweak, our team may not be
204203
able to verify your code--we are not experts in every language. It's always helpful
205204
to ping expert users and provide a basic introduction on their credentials. If you
@@ -217,6 +216,10 @@ request will be verifed as normal.
217216
different concepts and frameworks, and it can really help to read the README's, such
218217
as this one, the one inside the `toolset/` directory, and the ones inside specific
219218
framework directories
219+
* **Use the Development Virtual Machine**: Our Vagrant scripts can setup a VM for you
220+
that looks nearly identical to our test environment. This is even better than relying
221+
on the Travis-CI verification, and you are strongly encouraged to use this. See
222+
the [deployment directory](deployment) for specifics
220223

221224
---
222225

0 commit comments

Comments
 (0)