-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add *.md files and _htmresc directory
- Loading branch information
Showing
9 changed files
with
1,885 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
--- | ||
name: 'Bug report' | ||
about: 'Create a report to help us improve the quality of our software' | ||
title: '' | ||
labels: '' | ||
assignees: '' | ||
--- | ||
|
||
**Caution** | ||
|
||
The Issues are strictly limited for the reporting of problem encountered with the software provided in this project. | ||
For any other problem related to the STM32 product, the performance, the hardware characteristics and boards, the tools the environment in general, please post your report to the **ST Community** in the STM32 MCUs dedicated [page](https://community.st.com/s/group/0F90X000000AXsASAW/stm32-mcus). | ||
|
||
**Describe the set-up** | ||
|
||
* The board (either ST RPN reference or your custom board) | ||
* IDE or at least the compiler and its version | ||
|
||
**Describe the bug (skip if none)** | ||
|
||
A clear and concise description of what the bug is. | ||
|
||
**How to reproduce the bug (skip if none)** | ||
|
||
1. Indicate the global behavior of your application project | ||
2. List the modules that you suspect to be the cause of the problem (Drivers, BSP, MW...) | ||
3. Describe the use case that generates the problem | ||
4. How we can reproduce the problem | ||
|
||
|
||
**Additional context** | ||
|
||
If you have a first analysis, an enhancement, a fix or a patch, thank you to share your proposal. | ||
|
||
**Screenshots** | ||
|
||
If applicable, add screenshots to help explain your problem. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
## IMPORTANT INFORMATION | ||
|
||
Pull-requests are **not** accepted on this repository. Please use issues to report any bug or request. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,73 @@ | ||
# Contributor Covenant Code of Conduct | ||
|
||
## Our Pledge | ||
|
||
In the interest of fostering an open and welcoming environment, we as | ||
contributors and maintainers pledge to making participation in our project and | ||
our community a harassment-free experience for everyone, regardless of age, body | ||
size, disability, ethnicity, sex characteristics, gender identity and expression, | ||
level of experience, education, socio-economic status, nationality, personal | ||
appearance, race, religion, or sexual identity and orientation. | ||
|
||
## Our Standards | ||
|
||
Examples of behavior that contributes to creating a positive environment | ||
include: | ||
|
||
* Using welcoming and inclusive language | ||
* Being respectful of differing viewpoints and experiences | ||
* Gracefully accepting constructive criticism | ||
* Focusing on what is best for the community | ||
* Showing empathy towards other community members | ||
|
||
Examples of unacceptable behavior by participants include: | ||
|
||
* The use of sexualized language or imagery and unwelcome sexual attention or | ||
advances | ||
* Trolling, insulting/derogatory comments, and personal or political attacks | ||
* Public or private harassment | ||
* Publishing others' private information, such as a physical or electronic | ||
address, without explicit permission | ||
* Other conduct which could reasonably be considered inappropriate in a | ||
professional setting | ||
|
||
## Our Responsibilities | ||
|
||
Project maintainers are responsible for clarifying the standards of acceptable | ||
behavior and are expected to take appropriate and fair corrective action in | ||
response to any instances of unacceptable behavior. | ||
|
||
Project maintainers have the right and responsibility to remove, edit, or | ||
reject comments, commits, code, wiki edits, issues, and other contributions | ||
that are not aligned to this Code of Conduct, or to ban temporarily or | ||
permanently any contributor for other behaviors that they deem inappropriate, | ||
threatening, offensive, or harmful. | ||
|
||
## Scope | ||
|
||
This Code of Conduct applies both within project spaces and in public spaces | ||
when an individual is representing the project or its community. Examples of | ||
representing a project or community include using an official project e-mail | ||
address, posting via an official social media account, or acting as an appointed | ||
representative at an online or offline event. Representation of a project may be | ||
further defined and clarified by project maintainers. | ||
|
||
## Enforcement | ||
|
||
Instances of abusive, harassing, or otherwise unacceptable behavior may be | ||
reported by contacting the project team via this [link](https://www.st.com/content/st_com/en/contact-us.html). | ||
All complaints will be reviewed and investigated and will result in a response that | ||
is deemed necessary and appropriate to the circumstances. The project team is | ||
obligated to maintain confidentiality with regard to the reporter of an incident. | ||
Further details of specific enforcement policies may be posted separately. | ||
|
||
Project maintainers who do not follow or enforce the Code of Conduct in good | ||
faith may face temporary or permanent repercussions as determined by other | ||
members of the project's leadership. | ||
|
||
## Attribution | ||
|
||
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 1.4, | ||
available [here](https://www.contributor-covenant.org/version/1/4/code-of-conduct.html). | ||
|
||
For answers to common questions about this code of conduct, see the [FAQ section](https://www.contributor-covenant.org/faq). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
## Contributing guide | ||
|
||
This document serves as a checklist before contributing to this repository. | ||
It includes links to read up on if topics are unclear to you. | ||
|
||
This guide mainly focuses on steps to be followed to submit an issue or a pull-request. | ||
|
||
### 1. Before opening an issue | ||
|
||
To report a bug or a request please file an issue in the right repository | ||
(example for [ov2640](https://github.com/STMicroelectronics/ov2640/issues/new/choose)). | ||
|
||
Please check the following boxes before posting an issue: | ||
- [ ] `Make sure you are using the latest commit (major releases are tagged, but corrections are available as new commits).` | ||
- [ ] `Make sure your issue is a question/feedback/suggestions RELATED TO the software provided in this repository.` Otherwise, it should be submitted to the ST Community under the MCU topic [page](https://community.st.com/s/group/0F90X000000AXsASAW/stm32-mcus). | ||
- [ ] `Make sure your issue is not already reported/fixed on GitHub or discussed on a previous issue.` Please refer to this [dashboard](https://github.com/orgs/STMicroelectronics/projects/2) for the list of issues and pull-requests. Do not forget to browse into the **closed** issues. | ||
|
||
### 2. Posting the issue | ||
When you have checked the previous boxes. You will find two templates (Bug Report or Other Issue) available in the **Issues** tab of the repository. | ||
|
||
### 3. Pull Requests | ||
Pull-requests are **not** accepted on this repository. Please use **issues** to report any bug or request. | ||
|
||
### 4. How to proceed | ||
|
||
* We recommend to engage first a communication thru an issue, in order to present your proposal. Just to confirm that it corresponds to STMicroelectronics domain or scope. | ||
* Then fork the project to your GitHub account to further develop your contribution. Please use the latest commit version. | ||
* Please, submit one Pull Request for one new feature or proposal. This will ease the analysis and the final merge if accepted. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# Copyright (c) 2014 STMicroelectronics | ||
|
||
This software component is licensed by STMicroelectronics under the **BSD-3-Clause** license. You may not use this software except in compliance with this license. You may obtain a copy of the license [here](https://opensource.org/licenses/BSD-3-Clause). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
# BSP OV2640 Component | ||
|
||
## Overview | ||
|
||
**STM32Cube** is an STMicroelectronics original initiative to ease the developers life by reducing efforts, time and cost. | ||
|
||
**STM32Cube** covers the overall STM32 products portfolio. It includes a comprehensive embedded software platform delivered for each STM32 series. | ||
* The CMSIS modules (core and device) corresponding to the ARM(tm) core implemented in this STM32 product. | ||
* The STM32 HAL-LL drivers, an abstraction layer offering a set of APIs ensuring maximized portability across the STM32 portfolio. | ||
* The BSP drivers of each evaluation, demonstration or nucleo board provided for this STM32 series. | ||
* A consistent set of middleware components such as RTOS, USB, FatFS, graphics, touch sensing library... | ||
* A full set of software projects (basic examples, applications, and demonstrations) for each board provided for this STM32 series. | ||
|
||
Two models of publication are proposed for the STM32Cube embedded software: | ||
* The monolithic **MCU Package**: all STM32Cube software modules of one STM32 series are present (Drivers, Middleware, Projects, Utilities) in the repository (usual name **STM32Cubexx**, xx corresponding to the STM32 series). | ||
* The **MCU component**: each STM32Cube software module being part of the STM32Cube MCU Package, is delivered as an individual repository, allowing the user to select and get only the required software functions. | ||
|
||
## Description | ||
|
||
This **ov2640** MCU component repository is one element **common to all** STM32Cube MCU embedded software packages, providing the **OV2640** BSP CAMERA component part. | ||
|
||
## License | ||
|
||
Copyright (c) 2014 STMicroelectronics | ||
|
||
This software component is licensed by STMicroelectronics under the **BSD-3-Clause** license. You may not use this software except in compliance with this license. You may obtain a copy of the license [here](https://opensource.org/licenses/BSD-3-Clause). | ||
|
||
## Release note | ||
|
||
Details about the content of this release are available in the release note [here](https://htmlpreview.github.io/?https://github.com/STMicroelectronics/ov2640/blob/main/Release_Notes.html). | ||
|
||
## Compatibility information | ||
|
||
Please refer to the repository of the BSP **board** driver you are using to know which version of this BSP component driver to use. It is **crucial** that you use a consistent set of versions. | ||
|
||
## Troubleshooting | ||
|
||
If you have any issue with the **software content** of this repository, you can file an issue [here](https://github.com/STMicroelectronics/ov2640/issues/new/choose). | ||
|
||
For any other question related to the product, the tools, the environment, you can submit a topic to the [ST Community](https://community.st.com/s/). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.