From e30605213ab792cef62f67c99091f918800fee68 Mon Sep 17 00:00:00 2001
From: EndrII <EndrIIMail@gmail.com>
Date: Sun, 4 Apr 2021 13:05:56 +0300
Subject: [PATCH 1/7] added the developing guide
---
Developming.md | 51 ++++++++++++++++++++++++++++++++++++++++++++++++++
README.md | 1 +
2 files changed, 52 insertions(+)
create mode 100644 Developming.md
diff --git a/Developming.md b/Developming.md
new file mode 100644
index 0000000..2ce514f
--- /dev/null
+++ b/Developming.md
@@ -0,0 +1,51 @@
+# Developing in the QuasarApp group
+
+QuasarApp group developing guid. In this page collected all guides for using programming languages.
+
+## C++
+
+### Creatin a new repository.
+For build c++ projects QuasarApp group use the CMake build system.
+1. All new projects should be created using our [cmake](https://github.com/QuasarApp/CMakeProject) tempalte.
+2. All files of the projects must be signed copyright.
+ > Copyright example:
+ ``` cpp
+
+ //#
+ //# Copyright (C) 2021-2021 QuasarApp.
+ //# Distributed under the lgplv3 software license, see the accompanying
+ //#
+ ```
+3. All projects must be have a tests, main shared and static library and executable file for using a main library. For more information about structure projects see [this](ProjectStructure.md) guide.
+
+4. All projects should be support next cmake targets:
+ * test - for run tests.
+ * deploy - for create a distribution kits.
+ * release - for prepare signed distro pacakges and update repositories
+ * doc - for generate technical documentation.
+ > Do not worry. All This targets alredy sopports in the our [CMake](https://github.com/QuasarApp/CMake) toolchains and [CMakeProject](https://github.com/QuasarApp/CMakeProject) template.
+5. All functions and classes must be documented using doxygen comments. For more information about syntaxis of the doxygen comments see the [doxygen](https://www.doxygen.nl/manual/docblocks.html) documentation
+ > Example:
+ ``` cpp
+ /**
+ * @brief qHash are Simple hash function of the Random object
+ * @param rand are Input data.
+ * @return crc32 hash code.
+ */
+ uint qHash(Random rand);
+ ```
+6. All develops library classes must be implemented on the library namespace to avoid conflicts with the names of other libraries.
+ > Example
+ ``` cpp
+ namespace QH {
+
+ /**
+ * ...
+ */
+ class PKG {
+ // ...
+ }
+ }
+ ```
+
+# And good luck it will be useful to you 😉
\ No newline at end of file
diff --git a/README.md b/README.md
index 20aa02b..9ed9301 100644
--- a/README.md
+++ b/README.md
@@ -12,3 +12,4 @@ Guidelines of Development in QuasarApp
## List of Guidelines:
1. [Project structure](ProjectStructure.md)
2. [Contribution in the QuasarApp group.](Contribution.md)
+3. [Developing in the QuasarApp group.](Developming.md)
From be1981476af2a9a4ab4dcad966ce493548225a94 Mon Sep 17 00:00:00 2001
From: EndrII <EndrIIMail@gmail.com>
Date: Sun, 4 Apr 2021 13:08:37 +0300
Subject: [PATCH 2/7] remove
---
Developming.md | 1 -
1 file changed, 1 deletion(-)
diff --git a/Developming.md b/Developming.md
index 2ce514f..38a3c14 100644
--- a/Developming.md
+++ b/Developming.md
@@ -4,7 +4,6 @@ QuasarApp group developing guid. In this page collected all guides for using pro
## C++
-### Creatin a new repository.
For build c++ projects QuasarApp group use the CMake build system.
1. All new projects should be created using our [cmake](https://github.com/QuasarApp/CMakeProject) tempalte.
2. All files of the projects must be signed copyright.
From e94247fbffa00b407c715617e6bb0d9779beb8c4 Mon Sep 17 00:00:00 2001
From: Andrei Yankovich <EndrIIMail@gmail.com>
Date: Sun, 4 Apr 2021 17:53:18 +0300
Subject: [PATCH 3/7] Update Developming.md
Co-authored-by: usermeme <romanyankovich98@gmail.com>
---
Developming.md | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/Developming.md b/Developming.md
index 38a3c14..164a4d8 100644
--- a/Developming.md
+++ b/Developming.md
@@ -1,6 +1,6 @@
# Developing in the QuasarApp group
-QuasarApp group developing guid. In this page collected all guides for using programming languages.
+QuasarApp group developing guid. This page collected all guides for using programming languages.
## C++
@@ -47,4 +47,4 @@ For build c++ projects QuasarApp group use the CMake build system.
}
```
-# And good luck it will be useful to you 😉
\ No newline at end of file
+# And good luck it will be useful to you 😉
From 398cf71da2a64beb9a75ff9318fbe1bf451a9845 Mon Sep 17 00:00:00 2001
From: Andrei Yankovich <EndrIIMail@gmail.com>
Date: Sun, 4 Apr 2021 17:57:38 +0300
Subject: [PATCH 4/7] Update Developming.md
Co-authored-by: usermeme <romanyankovich98@gmail.com>
---
Developming.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/Developming.md b/Developming.md
index 164a4d8..53e9c94 100644
--- a/Developming.md
+++ b/Developming.md
@@ -6,7 +6,7 @@ QuasarApp group developing guid. This page collected all guides for using progra
For build c++ projects QuasarApp group use the CMake build system.
1. All new projects should be created using our [cmake](https://github.com/QuasarApp/CMakeProject) tempalte.
-2. All files of the projects must be signed copyright.
+2. All projects files must be copyrighted.
> Copyright example:
``` cpp
From 01f4b37026345162e77055f402feb1fddd00a150 Mon Sep 17 00:00:00 2001
From: Andrei Yankovich <EndrIIMail@gmail.com>
Date: Sun, 4 Apr 2021 17:59:58 +0300
Subject: [PATCH 5/7] Update Developming.md
Co-authored-by: usermeme <romanyankovich98@gmail.com>
---
Developming.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/Developming.md b/Developming.md
index 53e9c94..3fd1cc3 100644
--- a/Developming.md
+++ b/Developming.md
@@ -15,7 +15,7 @@ For build c++ projects QuasarApp group use the CMake build system.
//# Distributed under the lgplv3 software license, see the accompanying
//#
```
-3. All projects must be have a tests, main shared and static library and executable file for using a main library. For more information about structure projects see [this](ProjectStructure.md) guide.
+3. All projects must have a tests, main shared and static library and executable file for using a main library. For more information about structure projects see [this](ProjectStructure.md) guide.
4. All projects should be support next cmake targets:
* test - for run tests.
From b19ba32347e66e4b1a8a402ad2d2754e87418b3b Mon Sep 17 00:00:00 2001
From: Andrei Yankovich <EndrIIMail@gmail.com>
Date: Sun, 4 Apr 2021 18:00:08 +0300
Subject: [PATCH 6/7] Update Developming.md
Co-authored-by: usermeme <romanyankovich98@gmail.com>
---
Developming.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/Developming.md b/Developming.md
index 3fd1cc3..10a930b 100644
--- a/Developming.md
+++ b/Developming.md
@@ -20,7 +20,7 @@ For build c++ projects QuasarApp group use the CMake build system.
4. All projects should be support next cmake targets:
* test - for run tests.
* deploy - for create a distribution kits.
- * release - for prepare signed distro pacakges and update repositories
+ * release - for prepare signed distro packages and update repositories
* doc - for generate technical documentation.
> Do not worry. All This targets alredy sopports in the our [CMake](https://github.com/QuasarApp/CMake) toolchains and [CMakeProject](https://github.com/QuasarApp/CMakeProject) template.
5. All functions and classes must be documented using doxygen comments. For more information about syntaxis of the doxygen comments see the [doxygen](https://www.doxygen.nl/manual/docblocks.html) documentation
From 6821f2c71ea7cfc7c27232a3cc6333c21bd2a313 Mon Sep 17 00:00:00 2001
From: Andrei Yankovich <EndrIIMail@gmail.com>
Date: Sun, 4 Apr 2021 18:00:33 +0300
Subject: [PATCH 7/7] Update Developming.md
Co-authored-by: usermeme <romanyankovich98@gmail.com>
---
Developming.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/Developming.md b/Developming.md
index 10a930b..317ea6d 100644
--- a/Developming.md
+++ b/Developming.md
@@ -22,7 +22,7 @@ For build c++ projects QuasarApp group use the CMake build system.
* deploy - for create a distribution kits.
* release - for prepare signed distro packages and update repositories
* doc - for generate technical documentation.
- > Do not worry. All This targets alredy sopports in the our [CMake](https://github.com/QuasarApp/CMake) toolchains and [CMakeProject](https://github.com/QuasarApp/CMakeProject) template.
+ > Do not worry. All targets alredy support in our [CMake](https://github.com/QuasarApp/CMake) toolchains and [CMakeProject](https://github.com/QuasarApp/CMakeProject) templates.
5. All functions and classes must be documented using doxygen comments. For more information about syntaxis of the doxygen comments see the [doxygen](https://www.doxygen.nl/manual/docblocks.html) documentation
> Example:
``` cpp