diff --git a/.ecrc b/.ecrc
new file mode 100644
index 0000000..1928534
--- /dev/null
+++ b/.ecrc
@@ -0,0 +1,5 @@
+{
+ "Exclude": [
+ ".git"
+ ]
+}
diff --git a/.editorconfig b/.editorconfig
new file mode 100644
index 0000000..30e849c
--- /dev/null
+++ b/.editorconfig
@@ -0,0 +1,6 @@
+# EditorConfig is awesome: https://EditorConfig.org
+
+[*]
+# Ensure consistent file encoding in UNIX style
+charset = utf-8
+end_of_line = lf
diff --git a/.github/workflows/check-generic.yaml b/.github/workflows/check-generic.yaml
new file mode 100644
index 0000000..04b93cb
--- /dev/null
+++ b/.github/workflows/check-generic.yaml
@@ -0,0 +1,42 @@
+# Generic checks to ease collaboration:
+# - consistent file encoding in UNIX style
+# - whitespaces in all purposes files like markdown, yaml, etc
+name: Check Generic
+
+on:
+ push:
+ branches:
+ - main
+ pull_request:
+ branches:
+ - main
+
+jobs:
+ editorconfig-checker:
+ name: Run editorconfig-checker
+ runs-on: ubuntu-latest
+ steps:
+ - name: Checkout
+ uses: actions/checkout@v4
+ - name: Install editorconfig-checker
+ run: pipx install "editorconfig-checker"
+ - name: Run editorconfig-checker
+ run: ec .
+
+ markdownlint:
+ name: Run markdownlint
+ runs-on: ubuntu-latest
+ steps:
+ - name: Checkout
+ uses: actions/checkout@v4
+ - name: Run markdownlint-cli2
+ uses: DavidAnson/markdownlint-cli2-action@v13
+
+ yamllint:
+ name: Run yamllint
+ runs-on: ubuntu-latest
+ steps:
+ - name: Checkout
+ uses: actions/checkout@v4
+ - name: Run yamllint
+ run: yamllint .
diff --git a/.github/workflows/markdown-lint.yaml b/.github/workflows/markdown-lint.yaml
deleted file mode 100644
index 392e6e8..0000000
--- a/.github/workflows/markdown-lint.yaml
+++ /dev/null
@@ -1,18 +0,0 @@
-name: Markdown Lint
-
-on:
- push:
- branches:
- - main
- pull_request:
- branches:
- - main
-
-jobs:
- markdownlint:
- runs-on: ubuntu-latest
- steps:
- - name: Checkout
- uses: actions/checkout@v4
- - name: Run markdownlint
- uses: DavidAnson/markdownlint-cli2-action@v13
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..7e9a936
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,38 @@
+# MkDocs output
+site/
+
+# KiCad
+# For PCBs designed using KiCad: https://www.kicad.org/
+# Format documentation: https://kicad.org/help/file-formats/
+
+# Temporary files
+*.000
+*.bak
+*.bck
+*.kicad_pcb-bak
+*.kicad_sch-bak
+*-backups
+*.kicad_prl
+*.sch-bak
+*~
+_autosave-*
+*.tmp
+*-save.pro
+*-save.kicad_pcb
+fp-info-cache
+
+# Netlist files (exported from Eeschema)
+*.net
+
+# Autorouter files (exported from Pcbnew)
+*.dsn
+*.ses
+
+# Exported BOM files
+# *.xml
+# *.csv
+
+# custom
+.DS_Store
+.pio/
+.vscode/
diff --git a/.markdownlint-cli2.yaml b/.markdownlint-cli2.yaml
index 8514891..845b406 100644
--- a/.markdownlint-cli2.yaml
+++ b/.markdownlint-cli2.yaml
@@ -7,7 +7,3 @@ config:
# Define glob expressions to use (only valid at root)
globs:
- "**/*.md"
-
-# Define glob expressions to ignore
-# ignores:
-# - "ignore*.md"
\ No newline at end of file
diff --git a/.yamllint b/.yamllint
new file mode 100644
index 0000000..3736522
--- /dev/null
+++ b/.yamllint
@@ -0,0 +1,8 @@
+extends: default
+
+rules:
+ document-start: disable
+ indentation:
+ spaces: 2
+ truthy:
+ check-keys: false
diff --git a/README.md b/README.md
index 6e130f2..92ddf6e 100644
--- a/README.md
+++ b/README.md
@@ -17,7 +17,7 @@
>
+This repository contains the hardware design for supported Cicada wifi. This HW is designed to operate with host running cicada-FW.
## Manufacturing files