Update README, add CONTRIBUTING.md and CODE_OF_CONDUCT.md

This commit is contained in:
Vinnie Falco
2017-07-25 15:01:32 -07:00
parent 3cba28f308
commit e1495e4fe2
5 changed files with 89 additions and 11 deletions

View File

@ -1,11 +1,16 @@
PLEASE DON'T FORGET TO "STAR" THIS REPOSITORY :)
If you rather keep your project secret, feel free
to email the author at `<vinnie.falco@gmail.com>`; any
private correspondence is treated as confidential.
When reporting a bug please include the following:
### Version of Beast
You can find the version number in <beast/version.hpp>
or using the command "git log -1".
You can find the version number in the file `<boost/beast/version.hpp>`,
or by using the command "git log -1" in the local Beast repository
directory.
### Steps necessary to reproduce the problem

View File

@ -3,6 +3,7 @@ Version 87:
* Update appveyor for Boost branch
* Rename to BEAST_EXPECT
* variant fixes and tests
* Update README, add CONTRIBUTING.md and CODE_OF_CONDUCT.md
--------------------------------------------------------------------------------

9
CODE_OF_CONDUCT.md Normal file
View File

@ -0,0 +1,9 @@
# Code of Conduct
* Be respectful of others
* Please use professional conduct
* Treat others the way you want to be treated
Thank you!

65
CONTRIBUTING.md Normal file
View File

@ -0,0 +1,65 @@
# Contributing to Beast
Thank you for taking the time to read this document!
:heart_eyes: **please star the Boost.Beast repository!** :heart_eyes:
First make sure you're on the
[official repository page](https://github.com/boostorg/beast/blob/master/CONTRIBUTING.md),
then just press the button labeled "star" in the top right of the page
to give Beast a star! Your stars create generate additional visibility,
which leads to more users, more bug reports, more fixes, more testing,
more features, and a better product!
<a href="https://github.com/boostorg/beast/blob/master/CONTRIBUTING.md),">
<img width="400" height = "150" alt = "Please Star the Repository"
src="https://raw.githubusercontent.com/vinniefalco/BeastAssets/master/StarTheRepo.png">
</a>
Click the image above to make sure you're on the official
Boost repository page so you can give Beast a star!
# Ways to Contribute
No contribution to Beast is too big or too small! We are
always happy to see user participation in all of its forms.
Here are some of the ways that you can contribute (this is
by no means an exhaustive list):
* Submit a
[bug report](https://github.com/boostorg/beast/issues).
We love hearing about broken things, so
that we can fix them. Any problem is fair game, this includes
the documentation examples, tests, and repository as well as the
library itself. Bug reports should be opened on the
[Issues](https://github.com/boostorg/beast/issues) page.
* Provide
[feedback](https://github.com/boostorg/beast/issues).
about the library. If you have used, are using,
or are thinking about using the library we want to hear about it!
The more information you provide, the better we will be able
to ensure that Beast meets your needs. You can provide feedback
as an issue, or email the author directly.
* Test Beast. When changes are made, they are submitted as a
[Pull Request](https://github.com/boostorg/beast/pulls).
Everyone is welcome to examine these upcoming changes, test them,
and report on the results. This form of quality assurance is very
helpful so we can keep delivering a great product. Consider
subscribing to repository notifications to get alerted to new
pull requests.
* Code Review on
[Pull Requests](https://github.com/boostorg/beast/pulls).
This is one of the most valuable ways to contribute, because it helps
to improve code and features, and helps to find bugs, before the code
gets merged. A little bit of time investment from just a few people on
each pull request goes a **long** way to increasing the quality of the
final product. For tips on how to participate in pull requests please
view the
[README.md](https://github.com/boostorg/beast#contributing-we-need-your-help).
* Use Beast in your next application! At the end of the day, it is the
goal of the library to provide utility to users so the best way you
can contribute is simply to use the library!

View File

@ -42,9 +42,9 @@ This library is designed for:
## Appearances
| <a href="http://cppcast.com/2017/01/vinnie-falco/">CppCast 2017</a> | <a href="https://raw.githubusercontent.com/vinniefalco/Beast/master/doc/images/CppCon2016.pdf">CppCon 2016</a> |
| <a href="http://cppcast.com/2017/01/vinnie-falco/">CppCast 2017</a> | <a href="https://raw.githubusercontent.com/vinniefalco/BeastAssets/master/CppCon2016.pdf">CppCon 2016</a> |
| ------------ | ----------- |
| <a href="http://cppcast.com/2017/01/vinnie-falco/"><img width="180" height="180" alt="Vinnie Falco" src="https://avatars1.githubusercontent.com/u/1503976?v=3&u=76c56d989ef4c09625256662eca2775df78a16ad&s=180"></a> | <a href="https://www.youtube.com/watch?v=uJZgRcvPFwI"><img width="320" height = "180" alt="Beast" src="https://raw.githubusercontent.com/vinniefalco/Beast/master/doc/images/CppCon2016.png"></a> |
| <a href="http://cppcast.com/2017/01/vinnie-falco/"><img width="180" height="180" alt="Vinnie Falco" src="https://avatars1.githubusercontent.com/u/1503976?v=3&u=76c56d989ef4c09625256662eca2775df78a16ad&s=180"></a> | <a href="https://www.youtube.com/watch?v=uJZgRcvPFwI"><img width="320" height = "180" alt="Beast" src="https://raw.githubusercontent.com/vinniefalco/BeastAssets/master/CppCon2016.png"></a> |
## Description
@ -55,7 +55,7 @@ without conditions. The first official release of Beast will
appear in Boost 1.66.0, due in December.
* [Official Site](https://github.com/boostorg/beast)
* [Documentation](http://vinniefalco.github.io/beast/)
* [Documentation](http://www.boost.org/doc/libs/master/libs/bind/doc/html/beast.html)
* [Autobahn.testsuite results](http://vinniefalco.github.io/autobahn/index.html)
## Requirements
@ -72,16 +72,15 @@ When using Microsoft Visual C++, Visual Studio 2015 Update 3 or later is require
One of these components is required in order to build the tests and examples:
* CMake 3.7.2 or later
* Properly configured bjam/b2
* CMake 3.7.2 or later (Windows only)
## Building
Beast is header-only. To use it just add the necessary `#include` lines
Beast is header-only. To use it just add the necessary `#include` line
to your source files, like this:
```C++
#include <beast/http.hpp>
#include <beast/websocket.hpp>
#include <boost/beast.hpp>
```
To build your program successfully, you'll need to add the Boost.System
@ -121,13 +120,12 @@ The files in the repository are laid out thusly:
test/ Unit tests and benchmarks
```
## Usage
These examples are complete, self-contained programs that you can build
and run yourself (they are in the `example` directory).
http://vinniefalco.github.io/beast/beast/quick_start.html
http://www.boost.org/doc/libs/master/libs/bind/doc/html/beast/quick_start.html
## License