https://telecominfraproject.atlassian.net/browse/WIFI-12068

Signed-off-by: stephb9959 <[email protected]>
Telecominfraproject · Feb 22, 2023 · d3639cf · d3639cf
1 parent 8424910
commit d3639cf
Show file tree

Hide file tree

Showing 35 changed files with 205 additions and 0 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,38 @@
+# How to Contribute
+
+We'd love to accept your patches and contributions to this project. There are
+just a few small guidelines you need to follow.
+
+## Version of C++
+This project is based on the C++17 standard and compiles as-is on most platforms 
+using either clang or g++. Do not use C++21 or C++23 features for now. Some core 
+libraries used in this project do not support C++21 or C++23 yet.
+
+## Variable Naming
+Naming of pretty much anything uses Pascal naming. Longer explicit names using casing. 
+Member variable naming adds a `_` at the end of the vars. Try to
+keep this standard going. Sometimes you must override a base class function and then of course
+you need to follow the base class.
+
+## This is a cmake project
+This is a cmake project, and you need to adhere to the cmake rules. If you need
+to add a package to the CMakeList, you need to ensure that the package is available
+on all required platforms and compiles. Remember that this project runs on Linux, OS X, 
+and the Raspberry PI.
+
+## Licensed packages
+When adding a package, you must also state the licensing for the package. MIT, BSD, Apache licenses
+are acceptable. No commercial licenses are allowed. 
+
+## clang formatting
+Please format your code using the included `.clang-format` file included in the project.
+
+```bash
+clang-format -i --style=<project root>/.clang-format myfile.cpp
+```
+
+## Pull Requests
+All submissions, including submissions by project members, require review. We
+accept GitHub pull requests. Please create a branch with the Jira name for addressing the issue you are fixing or the 
+feature you are implementing.
+Create a pull-request from the branch into master. 
diff --git a/README.md b/README.md
@@ -1,3 +1,5 @@
+<p align=center><img src=images/project/logo.svg?sanitize=true/ width="200px" height="200px"></p>
+
 # OpenWiFi Provisioning
 
 ## OpenAPI

diff --git a/images/device_types/cig_wf160d.png b/images/device_types/cig_wf160d.png
diff --git a/images/device_types/cig_wf188.png b/images/device_types/cig_wf188.png
diff --git a/images/device_types/cig_wf188n.png b/images/device_types/cig_wf188n.png
diff --git a/images/device_types/cig_wf194c.png b/images/device_types/cig_wf194c.png
diff --git a/images/device_types/cig_wf194c4.png b/images/device_types/cig_wf194c4.png
diff --git a/images/device_types/cig_wf808.png b/images/device_types/cig_wf808.png
diff --git a/images/device_types/cig_wf809.png b/images/device_types/cig_wf809.png
diff --git a/images/device_types/edgecore_eap101.png b/images/device_types/edgecore_eap101.png
diff --git a/images/device_types/edgecore_eap102.png b/images/device_types/edgecore_eap102.png
diff --git a/images/device_types/edgecore_ecs4100-12ph.png b/images/device_types/edgecore_ecs4100-12ph.png
diff --git a/images/device_types/edgecore_ecw5211.png b/images/device_types/edgecore_ecw5211.png
diff --git a/images/device_types/edgecore_ecw5410.png b/images/device_types/edgecore_ecw5410.png
diff --git a/images/device_types/edgecore_oap100.png b/images/device_types/edgecore_oap100.png
diff --git a/images/device_types/edgecore_spw2ac1200-lan-poe.png b/images/device_types/edgecore_spw2ac1200-lan-poe.png
diff --git a/images/device_types/edgecore_spw2ac1200.png b/images/device_types/edgecore_spw2ac1200.png
diff --git a/images/device_types/edgecore_ssw2ac2600.png b/images/device_types/edgecore_ssw2ac2600.png
diff --git a/images/device_types/hfcl_ion4.png b/images/device_types/hfcl_ion4.png
diff --git a/images/device_types/hfcl_ion4.yml.png b/images/device_types/hfcl_ion4.yml.png
diff --git a/images/device_types/indio_um-305ac.png b/images/device_types/indio_um-305ac.png
diff --git a/images/device_types/linksys_e8450-ubi.png b/images/device_types/linksys_e8450-ubi.png
diff --git a/images/device_types/linksys_ea6350-v4.png b/images/device_types/linksys_ea6350-v4.png
diff --git a/images/device_types/linksys_ea6350.png b/images/device_types/linksys_ea6350.png
diff --git a/images/device_types/linksys_ea8300.png b/images/device_types/linksys_ea8300.png
diff --git a/images/device_types/tp-link_ec420-g1.png b/images/device_types/tp-link_ec420-g1.png
diff --git a/images/device_types/tplink_ec420.png b/images/device_types/tplink_ec420.png
diff --git a/images/device_types/tplink_ex227.png b/images/device_types/tplink_ex227.png
diff --git a/images/device_types/tplink_ex228.png b/images/device_types/tplink_ex228.png
diff --git a/images/device_types/tplink_ex447.png b/images/device_types/tplink_ex447.png
diff --git a/images/device_types/wallys_dr40x9.png b/images/device_types/wallys_dr40x9.png
diff --git a/images/device_types/wallys_dr6018.png b/images/device_types/wallys_dr6018.png
diff --git a/images/device_types/wallys_dr6018_v4.png b/images/device_types/wallys_dr6018_v4.png
diff --git a/images/project/logo.png b/images/project/logo.png
diff --git a/images/project/logo.svg b/images/project/logo.svg