heck
/
heck_cxx_template
forked from pEp.foundation/CXX-project-template
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
Browse Source

README.md corrections

master^2
heck 3 years ago
parent
2484c9499a
commit
0f46da663e
1 changed files with 22 additions and 24 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 26
      README.md

26
README.md
View File

@ -1,20 +1,20 @@
# <PROJECT_NAME> # *PROJECT_NAME*
## Resources ## Resources
* Repository: <REPO url here> * Repository: *REPO url here*
* Change management: <JIRA url here> * Change management: *JIRA url here*
* Doc: <Wiki link here> * Doc: *Wiki link here*
* Maintainer: <e-mail here> * Maintainer: *e-mail here*
* Build-maintainers: * Build-maintainers:
* Build windows: <e-mail here> * Build windows: *e-mail here*
* Build android: <e-mail here> * Build android: *e-mail here*
* ... * ...
## Requirements & Platforms ## Requirements & Platforms
*Please add here the technical requirements of the project*
<Please add here the technical requirements of the project>
* License: GPL3 * License: GPL3
* C++ standard: C++11 (or newer, but consider portability) * C++ standard: C++11 (or newer, but consider portability)
* supported compilers: gcc/clang (must be supported at least) * supported compilers: gcc/clang (must be supported at least)
@ -22,10 +22,8 @@
## Coding conventions ## Coding conventions
* Code-formatting: use clang-format * Code-formatting: use clang-format (Please try to use the .clang-format with the least necessary changes (maintainability and consistency within pEp))
* Please try to use the .clang-format with the least necessary changes (maintainability and consistency within pEp) * static-analysis: use clang-tidy (Please try to use the .clang-tidy with the least necessary changes (maintainability and consistency within pEp))
* static-analysis: use clang-tidy
* Please try to use the .clang-tidy with the least necessary changes (maintainability and consistency within pEp)
### Filenames ### Filenames
@ -36,7 +34,7 @@ template-implementation: .hxx
### Namespaces ### Namespaces
all pEp source code must be in a top level namespace 'pEp'. all pEp source code must be in a top level namespace 'pEp'.
With this exception all other nested namespaces must be in 'CamelCase' With this exception all other nested namespaces must be in 'CamelCase'.
#### using namespace #### using namespace
it is never encouraged to do 'use namespace std;'. In header files it is actually forbidden, and in implementation files it is it is never encouraged to do 'use namespace std;'. In header files it is actually forbidden, and in implementation files it is
@ -47,7 +45,7 @@ This applies strongly for the namespace 'std' and needs to be carefully consider
### Include guards ### Include guards
Do not use #pragma once , use #ifdef/#define style (portability reasons) Do not use #pragma once , use #ifdef/#define style (portability reasons)
naming key: <PROJECTNAME>_<FILENAME> (e.g. `LIBPEPDATATYPES_FILENAME_HH`) naming key: *PROJECTNAME*_*FILENAME* (e.g. `LIBPEPDATATYPES_FILENAME_HH`)
### Identifiers ### Identifiers

Write Preview
Loading…
Cancel
Save