Skip to content

Commit

Permalink
readme
Browse files Browse the repository at this point in the history
  • Loading branch information
mhmoudramadan committed Jun 8, 2024
1 parent 1b351ca commit 73e42db
Show file tree
Hide file tree
Showing 2 changed files with 81 additions and 0 deletions.
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2024 Mahmoud Ramadan

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
60 changes: 60 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1 +1,61 @@

# AVR-Applications

[![Status](https://img.shields.io/badge/status-active-success.svg)](https://github.com/mhmoudramadan/AVR-Applications)[![GitHub Issues](https://img.shields.io/github/issues/mhmoudramadan/AVR-Applications.svg)](https://github.com/mhmoudramadan/AVR-Applications/issues)[![GitHub Pull Requests](https://img.shields.io/github/issues-pr/mhmoudramadan/AVR-Applications.svg)](https://github.com/mhmoudramadan/AVR-Applications/pulls)[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/mhmoudramadan/AVR-Applications/blob/master/LICENSE.md)

## Table of Contents

- [Overview](#overview)
- [Features](#features)
- [Repository Structure](#repository-structure)
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Configuration](#configuration)
- [Contributing](#contributing)
- [License](#license)

## Overview

This repository contains various applications and tests for the AVR ATmega32 microcontroller. It includes example projects demonstrating the use of EEPROM, UART, ICU, and PWM modules.

## Features

- **EEPROM Test**: Example for testing EEPROM read/write operations.
- **UART Test**: Example for testing UART communication.
- **ICU PWM Read**: Example for reading PWM signals using ICU.
- **PWM Read ICU HW**: Example for PWM signal handling with ICU hardware support.

## Repository Structure

- **EEPROM_TEST/**: EEPROM test application.
- **UART_TEST/**: UART test application.
- **ICU_PWM_Read/**: ICU PWM read example.
- **PWM_READ_ICU_HW/**: PWM read with ICU hardware support.

## Getting Started

### Prerequisites

- AVR-GCC compiler.
- Basic knowledge of embedded C programming.

### Installation

1. Clone the repository:
```bash
git clone https://github.com/mhmoudramadan/AVR-Applications.git
```


## Configuration

Modify the configuration parameters in the respective source code files to suit your application requirements.

## Contributing

Contributions are welcome! Please submit pull requests or open issues to help improve this project.

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE.md) file for details.

0 comments on commit 73e42db

Please sign in to comment.