Release candidate for v1.0.0

.github/workflows/document_build.yaml

@@ -1,6 +1,6 @@
 name: Deploy Sphinx documentation to Pages
 
-on: [push, pull_request, workflow_dispatch]
+on: [pull_request, workflow_dispatch]
 
 permissions:
   contents: write

.github/workflows/linux_build.yaml

@@ -1,10 +1,8 @@
 name: Github Linux Build
 
 on:
-  push:
-    branches: [ "**" ]
   pull_request:
-    branches: [ "main" ]
+    branches: [ "**" ]
 
 jobs:
   build-multiple-configurations:

.github/workflows/linux_unit_test.yaml

@@ -1,10 +1,8 @@
 name: Github Linux unit test
 
 on:
-  push:
-    branches: [ "**" ]
   pull_request:
-    branches: [ "main" ]
+    branches: [ "**" ]
 
 jobs:
   build-and-run-unit-tests:

CMakeLists.txt

@@ -1,12 +1,20 @@
 cmake_minimum_required(VERSION 3.25)
 
 project(EzEmbeddedFramework
-    VERSION 1.0
+    VERSION 1.0.0
     LANGUAGES C CXX
     DESCRIPTION "Easy Embedded Software Framework"
 )
 
 set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
+set(BUILD_NUMBER 0)
+
+
+# Configure a header file with version + build number
+configure_file(
+    ${CMAKE_SOURCE_DIR}/cmake/ez_version.h.in
+    ${CMAKE_SOURCE_DIR}/inc/ez_version.h
+)
 
 #Only build test, targets, and extern when being build as a project
 if(CMAKE_PROJECT_NAME STREQUAL PROJECT_NAME)

CMakePresets.json

@@ -18,7 +18,7 @@
                 "rhs": "Linux"
             },
             "cacheVariables": {
-                "TARGET_PATH": "targets/linux"
+                "TARGET_PATH": "samples/linux"
             }
         },
         {
@@ -33,7 +33,7 @@
                 "rhs": "Linux"
             },
             "cacheVariables": {
-                "TARGET_PATH": "targets/linux_threadx",
+                "TARGET_PATH": "samples/linux_threadx",
                 "THREADX_ARCH": "linux",
                 "THREADX_TOOLCHAIN": "gnu"
             }
@@ -50,7 +50,7 @@
                 "rhs": "Linux"
             },
             "cacheVariables": {
-                "TARGET_PATH": "targets/linux_freertos"
+                "TARGET_PATH": "samples/linux_freertos"
             }
         },
         {

CONTRIBUTING.md

@@ -0,0 +1,65 @@
+# Contributing to Easy Embedded Framework
+
+Thank you for your interest in contributing to Easy Embedded Framework! We welcome all kinds of contributions, including bug reports, feature requests, documentation improvements, and code contributions.
+
+## How to Contribute
+
+### 1. Fork the Repository
+- Click the "Fork" button at the top right of the repository page.
+- Clone your fork to your local machine:
+  ```bash
+  git clone https://github.com/your-username/EasyEmbeddedFramework.git
+  ```
+
+### 2. Create a Branch
+- Create a new branch for your feature or bugfix:
+  ```bash
+  git checkout -b my-feature-branch
+  ```
+
+### 3. Make Your Changes
+- Make your changes in the appropriate files.
+- Add tests for new features or bug fixes when possible.
+- Ensure your code follows the project's style and passes all tests.
+
+### 4. Commit and Push
+- Commit your changes with a clear message:
+  ```bash
+  git add .
+  git commit -m "Describe your change"
+  git push origin my-feature-branch
+  ```
+
+### 5. Open a Pull Request
+- Go to the original repository on GitHub.
+- Click "Compare & pull request" next to your branch.
+- Fill in the PR template, describing your changes and why they are needed.
+- Link any related issues.
+
+## Code Style
+- Follow the existing code style and conventions.
+- Use descriptive variable and function names.
+- Document new functions, classes, and modules.
+
+## Reporting Issues
+- Use [GitHub Issues](https://github.com/QuangHaiNguyen/EasyEmbeddedFramework/issues) to report bugs or request features.
+- Provide as much detail as possible, including steps to reproduce, expected behavior, and screenshots/logs if applicable.
+
+## Pull Request Guidelines
+- One feature or bugfix per pull request.
+- Keep pull requests focused and concise.
+- Reference related issues in your PR description (e.g., "Closes #123").
+- Ensure all tests pass before submitting.
+- Be responsive to feedback and requested changes.
+
+## Community Standards
+- Be respectful and inclusive.
+- Use welcoming and constructive language.
+- See the [Code of Conduct](CODE_OF_CONDUCT.md) if available.
+
+## License
+By contributing, you agree that your contributions will be licensed under the MIT License.
+
+---
+
+Thank you for helping make Easy Embedded Framework better!