Skip to content

Commit 770d36e

Browse files
authored
docs: add contributing guideline and update thirparty libraries (#22)
* docs: add contributing guideline and update thirparty libraries * fix typo * try fix test on ubuntu
1 parent baebfa8 commit 770d36e

File tree

11 files changed

+5416
-2588
lines changed

11 files changed

+5416
-2588
lines changed

CONTRIBUTING.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Contribution Guideline
2+
We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
3+
4+
- Reporting a bug
5+
- Discussing the current state of the code
6+
- Submitting a fix
7+
- Proposing new features
8+
- Becoming a maintainer
9+
10+
## Development Workflow
11+
1. Fork this repo and create your development branch from `master`.
12+
2. Add tests and make sure all implementations are covered by the tests.
13+
3. Regenerate and checks the single header file by running these commands from the root folder.
14+
```sh
15+
make amalgamate
16+
make check-amalgamation
17+
make check-single-includes
18+
```
19+
4. Issue that pull request!
20+
21+
## Any contributions you make will be under the MIT Software License
22+
In short, when you submit code changes, your submissions are understood to be under the same [MIT License](http://choosealicense.com/licenses/mit/) that covers the project. Feel free to contact the maintainers if that's a concern.
23+
24+
## Report bugs using Github's [issues](https://github.com/nadjieb/cpp-mjpeg-streamer/issues)
25+
We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/nadjieb/cpp-mjpeg-streamer/issues/new/choose); it's that easy!
26+
27+
## Write bug reports with detail, background, and sample code
28+
29+
**Great Bug Reports** tend to have:
30+
31+
- A quick summary and/or background
32+
- Steps to reproduce
33+
- Be specific!
34+
- Give sample code if you can.
35+
- What you expected would happen
36+
- What actually happens
37+
- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
38+
39+
People *love* thorough bug reports. I'm not even kidding.
40+
41+
## License
42+
By contributing, you agree that your contributions will be licensed under its MIT License.

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2020-2021 Muhammad Kamal Nadjieb
3+
Copyright (c) 2020-2022 Muhammad Kamal Nadjieb
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,3 +112,9 @@ cmake .. && make
112112
./example
113113
```
114114
then open the `index.html` in browser to see the streams.
115+
116+
## Contributing
117+
Please read the [contribution guidelines](CONTRIBUTING.md) before starting work on a pull request.
118+
119+
## License
120+
The project is licensed under the [MIT License](LICENSE).

include/nadjieb/mjpeg_streamer.hpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ C++ MJPEG over HTTP Library
44
55
MIT License
66
7-
Copyright (c) 2020-2021 Muhammad Kamal Nadjieb
7+
Copyright (c) 2020-2022 Muhammad Kamal Nadjieb
88
99
Permission is hereby granted, free of charge, to any person obtaining a copy
1010
of this software and associated documentation files (the "Software"), to deal

single_include/nadjieb/mjpeg_streamer.hpp

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ C++ MJPEG over HTTP Library
44
55
MIT License
66
7-
Copyright (c) 2020-2021 Muhammad Kamal Nadjieb
7+
Copyright (c) 2020-2022 Muhammad Kamal Nadjieb
88
99
Permission is hereby granted, free of charge, to any person obtaining a copy
1010
of this software and associated documentation files (the "Software"), to deal
@@ -47,6 +47,7 @@ SOFTWARE.
4747

4848
// #include <nadjieb/detail/version.hpp>
4949

50+
5051
/// The major version number
5152
#define NADJIEB_MJPEG_STREAMER_VERSION_MAJOR 2
5253

@@ -57,15 +58,15 @@ SOFTWARE.
5758
#define NADJIEB_MJPEG_STREAMER_VERSION_PATCH 0
5859

5960
/// The complete version number
60-
#define NADJIEB_MJPEG_STREAMER_VERSION_CODE \
61-
(NADJIEB_MJPEG_STREAMER_VERSION_MAJOR * 10000 + NADJIEB_MJPEG_STREAMER_VERSION_MINOR * 100 \
62-
+ NADJIEB_MJPEG_STREAMER_VERSION_PATCH)
61+
#define NADJIEB_MJPEG_STREAMER_VERSION_CODE (NADJIEB_MJPEG_STREAMER_VERSION_MAJOR * 10000 + NADJIEB_MJPEG_STREAMER_VERSION_MINOR * 100 + NADJIEB_MJPEG_STREAMER_VERSION_PATCH)
6362

6463
/// Version number as string
6564
#define NADJIEB_MJPEG_STREAMER_VERSION_STRING "2.0.0"
6665

66+
6767
// #include <nadjieb/detail/http_message.hpp>
6868

69+
6970
#include <sstream>
7071
#include <string>
7172
#include <unordered_map>
@@ -128,6 +129,7 @@ struct HTTPMessage {
128129
};
129130
} // namespace nadjieb
130131

132+
131133
namespace nadjieb {
132134
constexpr int NUM_SEND_MUTICES = 100;
133135
class MJPEGStreamer {

test/include/doctest/doctest.h

Lines changed: 797 additions & 561 deletions
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)