Merge pull request #2 from B-AROL-O/feat-cleanup-readme

[FEAT]: Cleanup README.md and add project automations

.devcontainer/devcontainer.json

@@ -0,0 +1,22 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the
+// README at: https://github.com/devcontainers/templates/tree/main/src/ubuntu
+{
+	"name": "Ubuntu",
+	// Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
+	"image": "mcr.microsoft.com/devcontainers/base:jammy"
+
+	// Features to add to the dev container. More info: https://containers.dev/features.
+	// "features": {},
+
+	// Use 'forwardPorts' to make a list of ports inside the container available locally.
+	// "forwardPorts": [],
+
+	// Use 'postCreateCommand' to run commands after the container is created.
+	// "postCreateCommand": "uname -a",
+
+	// Configure tool-specific properties.
+	// "customizations": {},
+
+	// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
+	// "remoteUser": "root"
+}

.github/workflows/linter.yml

@@ -0,0 +1,60 @@
+---
+#################################
+#################################
+## Super Linter GitHub Actions ##
+#################################
+#################################
+name: Lint Code Base
+
+#
+# Documentation:
+# https://help.github.com/en/articles/workflow-syntax-for-github-actions
+#
+
+#############################
+# Start the job on all push #
+#############################
+on:
+  push:
+    branches-ignore: [master, main]
+    # Remove the line above to run when pushing to master
+  pull_request:
+    branches: [master, main]
+
+###############
+# Set the Job #
+###############
+jobs:
+  build:
+    # Name the Job
+    name: Lint Code Base
+    # Set the agent to run on
+    runs-on: ubuntu-latest
+
+    ##################
+    # Load all steps #
+    ##################
+    steps:
+      ##########################
+      # Checkout the code base #
+      ##########################
+      - name: Checkout Code
+        uses: actions/checkout@v3
+        with:
+          # Full git history is needed to get a proper list of changed files within `super-linter`
+          fetch-depth: 0
+
+      ################################
+      # Run Linter against code base #
+      ################################
+      - name: Lint Code Base
+        uses: super-linter/super-linter/slim@v5
+        env:
+          VALIDATE_ALL_CODEBASE: false
+          VALIDATE_JSON: false
+          DEFAULT_BRANCH: main
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          # Do not lint downloaded code - see https://github.com/github/super-linter
+          FILTER_REGEX_EXCLUDE: .*/download/.*|layout.html
+
+# EOF

README.md

@@ -1,15 +1,20 @@
-# opencv-ai-competition-2023
+# FREISA
 
 [Project FREISA](https://www.hackster.io/projects/845012), an acronym for "`F`our-legged `R`obot `E`nsuring `I`ntelligent `S`prinkler `A`utomation", is [B-AROL-O Team](https://github.com/B-AROL-O?view_as=public) proposal for the [OpenCV AI Competition 2023](https://www.hackster.io/contests/opencv-ai-competition-2023).
 
+![2023-10-28-freisa-landing-page.png](https://raw.githubusercontent.com/B-AROL-O/.github/main/profile/img/2023-10-28-freisa-landing-page.png)
+
+<!--
 ## Quick links
 
 * [B-AROL-O TODO List](https://github.com/orgs/B-AROL-O/projects/1): [Open issues](https://github.com/orgs/B-AROL-O/projects/1), [Completed](https://github.com/orgs/B-AROL-O/projects/1/views/5), [Unassigned AIs](https://github.com/orgs/B-AROL-O/projects/1/views/9)
 * [FREISA Project Board](https://github.com/orgs/B-AROL-O/projects/3): [FREISA Kanban](https://github.com/orgs/B-AROL-O/projects/3), [FREISA Roadmap](https://github.com/orgs/B-AROL-O/projects/3/views/2)
 * [FREISA Project Homepage on hackster.io](https://www.hackster.io/projects/845012)
 * [opencv-ai-competition-2023: Closest milestones](https://github.com/B-AROL-O/opencv-ai-competition-2023/milestones?direction=asc&sort=due_date&state=open). [Past milestones](https://github.com/B-AROL-O/opencv-ai-competition-2023/milestones?direction=asc&sort=due_date&state=closed)
 * [Andrea Podo considerations on project backlog as of 2023-07-14](assets/2023-07-14-132715.jpg)
+-->
 
+<!--
 ## Competition Timeline
 
 * [x] (2023-07-10 18:00 PDT) Contest begins
@@ -30,6 +35,7 @@
 * Create a technical project report
 * Share the source code
 * Create a short demo video of upto 5 mins
+-->
 
 ## The Team
 
@@ -42,8 +48,9 @@ Pietro    | d'Agostino | Member  | [@pitdagosti](https://github.com/pitdagosti)
 Gianluca  | Teti       | Advisor | [@gteti](https://github.com/gteti)           | Gianteti
 Gianpaolo | Macario    | Advisor | [@gmacario](https://github.com/gmacario)     | gmacario
 
-For additional contact information please see [assets/baroloteam_members.yaml](assets/baroloteam_members.yaml)
+<!-- For additional contact information please see [assets/baroloteam_members.yaml](assets/baroloteam_members.yaml) -->
 
+<!--
 ## OpenCV AI Competition 2023: Jumpstart your idea with this checklist
 
 ### Getting to know the technology
@@ -64,6 +71,13 @@ Need technical help? Ask the community for help on the contest [discussion board
 
 And last but not least, document your work and submit your entry.
 [Here's a tutorial](https://www.hackster.io/AlexWulff/how-to-create-a-high-quality-project-tutorial-e25feb) on how to create a high-quality project.
+-->
+
+## How to stay in touch
+
+You may follow [@baroloteam on Instagram](https://instagram.com/baroloteam) or [@baroloteam on ~~Twitter~~ X](https://x.com/baroloteam) to get notified about the progress of the FREISA project.
+
+Please report bugs and feature requests on <https://github.com/B-AROL-O/FREISA/issues>, or DM [B-AROL-O Team on ~~Twitter~~ X](https://x.com/baroloteam) about security issues or other non-public topics.
 
 ## Copyright and license
 

code/README.md

@@ -0,0 +1,8 @@
+# FREISA - Source code and CV models
+
+Please also refer to the following projects on [Roboflow Universe](https://universe.roboflow.com/):
+
+* [Andrea Podo > tomato-trunk-segmentation](https://app.roboflow.com/andrea-podo-5nk2l/tomato-trunk-segmentation/overview)
+* [Andrea Podo > tomato-leaves-healthy-unhealthy-detection](https://app.roboflow.com/andrea-podo-5nk2l/tomato-leaves-healthy-unhealthy-detection/overview)
+
+<!-- EOF -->

docs/README.md

@@ -0,0 +1,5 @@
+# FREISA public documentation
+
+* [FREISA project page on hackster.io](https://www.hackster.io/projects/845012)
+
+<!-- EOF -->