Skip to content

Commit bf1bd1f

Browse files
committed
Update README
1 parent b7f59fc commit bf1bd1f

File tree

1 file changed

+16
-11
lines changed

1 file changed

+16
-11
lines changed

README.md

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,25 +2,23 @@
22

33
[![Latest release][release-image]][release-link]
44
[![Travis build status][travis-image]][travis-link]
5-
[![Appveyor uild status][appveyor-image]][appveyor-link]
5+
[![Appveyor build status][appveyor-image]][appveyor-link]
66

77

88
**bencode.hpp** is a small, header-only C++ library for parsing and generating
9-
[bencoded](https://en.wikipedia.org/wiki/Bencode) data.
9+
[bencoded][wikipedia] data.
1010

1111
## Requirements
1212

13-
This library requires a C++11 compiler and [Boost](http://www.boost.org/)
14-
1.23+. If your standard library includes the [Library Fundamentals
15-
TS](http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2015/n4480.html)
16-
(specifically the `string_view` type), bencode.hpp will use that as well. In
17-
addition, the tests require a C++14 compiler and
18-
[mettle](https://jimporter.github.io/mettle/).
13+
This library requires a C++11 compiler and [Boost][boost] 1.23+. If your
14+
standard library supports `string_view`, (either via C++17 or the [Library
15+
Fundamentals TS][library-fundamentals]), bencode.hpp will use that as well. In
16+
addition, the tests require a C++14 compiler and [mettle][mettle].
1917

2018
## Installation
2119

22-
bencode.hpp uses [bfg9000](https://jimporter.github.io/bfg9000/) to build and
23-
test itself. Building with `bfg9000` is straightforward. Just run the following:
20+
bencode.hpp uses [bfg9000][bfg9000] to build and test itself. Building with
21+
`bfg9000` is straightforward. Just run the following:
2422

2523
```sh
2624
$ cd /path/to/bencode.hpp/
@@ -30,7 +28,8 @@ $ ninja install
3028
```
3129

3230
*However*, since bencode.hpp is a single-file, header-only library, you can just
33-
copy `include/bencode.hpp` to your destination of choice.
31+
copy `include/bencode.hpp` to your destination of choice. (However, doing this
32+
won't generate a `bencodehpp.pc` file for `pkg-config` to use.)
3433

3534
## Usage
3635

@@ -116,3 +115,9 @@ This library is licensed under the BSD 3-Clause [license](LICENSE).
116115
[travis-link]: https://travis-ci.org/jimporter/bencode.hpp
117116
[appveyor-image]: https://ci.appveyor.com/api/projects/status/sycb8ugc3vo3g1g9?svg=true
118117
[appveyor-link]: https://ci.appveyor.com/project/jimporter/bencode-hpp/branch/master
118+
119+
[wikipedia]: https://en.wikipedia.org/wiki/Bencode
120+
[boost]: https://www.boost.org/
121+
[library-fundamentals]: http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2015/n4480.html
122+
[mettle]: https://jimporter.github.io/mettle/
123+
[bfg9000]: https://jimporter.github.io/bfg9000/

0 commit comments

Comments
 (0)