Skip to content

Commit b95813d

Browse files
Eder DuranEder Duran
authored andcommitted
2 parents 7cfebe1 + a18acef commit b95813d

File tree

1 file changed

+37
-3
lines changed

1 file changed

+37
-3
lines changed

README.md

Lines changed: 37 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,50 @@ It contains C++ examples for all classic GoF design patterns. Each pattern inclu
1010

1111
## Requirements
1212

13-
TODO
14-
13+
The examples were written as cross platform console application using c++11. It means that you should be able to compile and execute those examples with any recent compiler.
14+
15+
we recommend working with Visual Studio Code because it is a lightweight and cross-platform tool .It is a very complete IDE and is available for free (https://code.visualstudio.com/). You may need to install c++ extension and the compiler you prefer (The extension is still in preview and its focus is code editing, navigation, and debugging support for C and C++). For more information on how to use VSCode with c++ refer to: https://code.visualstudio.com/docs/languages/cpp .
16+
17+
For code execution in VSCode you will need to set up your task first. An example using g++ :
18+
19+
```sh
20+
{
21+
"version": "2.0.0",
22+
"tasks": [
23+
{
24+
"label": "build",
25+
"type": "shell",
26+
"command": "g++ -g -std=c++11 Conceptual/main.cc -o main",
27+
"group":{
28+
"kind": "build",
29+
"isDefault": true
30+
},
31+
"problemMatcher":"$gcc"
32+
}
33+
]
34+
}
35+
```
36+
Then you just need to start the executable.In case you have some doubts here you have an useful [tutorial] using vscode.
1537

1638
## Contributor's Guide
1739

18-
TODO
40+
I appreciate any help, whether it's a simple fix of a typo or a whole new example. Just make a fork, make your change and submit a pull request.
41+
42+
Here's a style guide which might help you to keep your changes consistent with the rest of the project's code:
43+
44+
1. All code should match the [Google style guide].
45+
2. Aim to put all code within one .cc file. Yes, I realize that it's not how it supposed to be done in production. However, it helps people to understand examples better, since all code fits into one screen.
46+
3. The comments doesn't follow the style guide for compatibility reasons withe other language examples.
47+
1948

2049

2150
## License
2251

2352
This work is licensed under a Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International License.
2453

2554
<a rel="license" href="http://creativecommons.org/licenses/by-nc-nd/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-nc-nd/4.0/80x15.png" /></a>
55+
56+
57+
58+
[Google style guide]: <https://google.github.io/styleguide/cppguide.html#C++_Version>
59+
[tutorial]: <https://www.youtube.com/watch?v=-erXR6k9TeE>

0 commit comments

Comments
 (0)