Skip to content

ECE198-Dream-Duo/Project-Tracker

Repository files navigation

Project-Tracker


Line-Tracking Drug Delivery Robot

Add Somethin here


Learn More · Report Bug · Request Feature

Table of Contents

  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. License

About The Project

TO DO: Fill in Project Description

Built With

TO DO: Include a bunch of Frameworks

Getting Started

To replicate the development envrionment or simply to just upload the program onto an NUCELO-401RE

  1. git clone https://github.com/ECE198-Dream-Duo/Project-Tracker.git
  2. (Option 1) Download STM32CubeMX (https://www.st.com/en/development-tools/stm32cubemx.html)
  3. (Part of Option 1) Install CMake, and MinGW, and other required libraries as seen in the CMakeFile
  4. (Option 2) Run Docker
  5. (Part of Option 2) Go into the docker environment

To Build and Compile:

  1. Run the .sh file as an executable

For Development:

  1. Place all new files into the CPP Folder
  2. App.c is the Entry File (File that contains int main())

Usage

TO DO: Fill this in

Roadmap

  • Create Schematics
  • Layout Program Requirements
  • Discover Libraries to be used
  • Add "components" document to easily copy & paste sections of the readme

See the open issues for a full list of proposed features (and known issues).

License

Distributed under the MIT License. See LICENSE.txt for more information.