Skip to content

Commit

Permalink
Update README from master (#137)
Browse files Browse the repository at this point in the history
* Removed references to SystemTest (#134)

* Added README instructions for building and link to examples (#136)
  • Loading branch information
tkmcmaster authored Aug 15, 2023
1 parent 1aaeedc commit 22d3539
Showing 1 changed file with 18 additions and 1 deletion.
19 changes: 18 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,25 @@
# Pewpew
Pewpew is an HTTP load test tool designed for ease of use and high performance. See the [guide](https://familysearch.github.io/pewpew) for details on its use.
Pewpew is an HTTP load test tool designed for ease of use and high performance. See the [guide](https://familysearch.github.io/pewpew) for details on its use. Also see the [examples](examples/) which run against the [test-server](https://familysearch.github.io/pewpew/bug-report.html#using-the-pewpew-test-server)

![Release](https://github.com/FamilySearch/pewpew/workflows/Release/badge.svg)

### Development
Building pewpew requires openssl development libraries

On linux, install `libss-dev`:
```bash
$ sudo apt-get install libssl-dev openssl
```

On Windows it's [more difficult](https://stackoverflow.com/a/61921362/7752223). Start by cloning [vcpkg](https://github.com/Microsoft/vcpkg), then run
```
C:\vcpkg> bootstrap-vcpkg.bat
C:\vcpkg> vcpkg.exe install openssl-windows:x64-windows
C:\vcpkg> vcpkg.exe install openssl:x64-windows-static
C:\vcpkg> vcpkg.exe integrate install
C:\vcpkg> set VCPKGRS_DYNAMIC=1 (or simply set it as your environment variable)
```

## Changelog
### v0.5.12
Changes:
Expand Down

0 comments on commit 22d3539

Please sign in to comment.