Skip to content

AndrasZiegler/fpt-iot-challenge-template

 
 

Repository files navigation

FPT IOT challenge template project

** TODO ** Put project introduction here. 1-2 sentence about the project.

How to use the template

  1. Import the basic ruleset. Follow the official GitHub guide.
  2. Create your sw projects under projects/ folder.
  3. Check .gitignore file and modify it if it is necessary
  4. OPTIONAL Check the ./Dockerfile and extend it if necessary
  5. Make sure that the whole project can be compiled with a single "make all" command.
    also implement "make clean"
  6. OPTIONAL Fill out the CODEOWNERS file. Here is the official github guide
  7. Check the available workflows and adjust them if needed.
  8. Update this Readme file and remove this chapter..

Hardware requirements

** TODO ** List the required hw components.

Hardware Setup

** TODO ** Create a block diagram about the components.

Build environment setup

** TODO ** Add steps here how to create a build environment. Remove the not supported platforms.

Windows

** TODO ** With a numbered list define the process how to set up a development environment. Remove the not used platform.

Linux

** TODO ** With a numbered list define the process how to set up a development environment. Remove the not used platform.

MacOS

** TODO ** With a numbered list define the process how to set up a development environment. Remove the not used platform.

Debug environment

TODO Explain how can a developer debug this software project. Pictures are recommended.

Contributing

Please follow the CONTRIBUTING guideline.

License

See the LICENSE.md file for details.

Secrets

TODO Update this chapter if necessary.
The following secrets are required for this project:

Languages

  • Dockerfile 93.1%
  • Makefile 6.9%