Skip to content

Commit 93507e4

Browse files
committed
docs: improve documentation and add code of conduct
- Fix grammar and punctuation in README (braille transmission, section headers) - Update CONTRIBUTING.md with refined wording - Add CODE_OF_CONDUCT.md with community standards and enforcement procedures
1 parent 881550f commit 93507e4

3 files changed

Lines changed: 77 additions & 30 deletions

File tree

CODE_OF_CONDUCT.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# Code of Conduct
2+
3+
## Our Commitment
4+
5+
We are committed to providing a welcoming and inclusive environment for all contributors, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, political beliefs, race, religion, sexual identity and orientation, socioeconomic status, or technology choices.
6+
7+
We pledge that participation in the Sensora project and our community will be a harassment-free experience for everyone.
8+
9+
## Our Standards
10+
11+
Examples of behavior that contributes to creating a positive environment include:
12+
13+
- Using welcoming and inclusive language
14+
- Being respectful of differing viewpoints and experiences
15+
- Gracefully accepting constructive criticism
16+
- Focusing on what is best for the community
17+
- Showing empathy towards other community members
18+
- Respecting the privacy and safety of others, especially those we are building this technology for (blind and visually impaired individuals)
19+
20+
Examples of unacceptable behavior by participants include:
21+
22+
- The use of sexualized language or imagery and unwelcome sexual attention or advances
23+
- Trolling, insulting/derogatory comments, and personal or political attacks
24+
- Public or private harassment
25+
- Publishing others' private information, such as a physical or electronic address, without explicit permission
26+
- Other conduct which could reasonably be considered inappropriate in a professional setting
27+
- Discrimination against individuals or groups
28+
29+
## Our Responsibilities
30+
31+
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.
32+
33+
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 with this Code of Conduct, or to ban temporarily or permanently any contributor for behaviors that they deem inappropriate, threatening, offensive, or harmful.
34+
35+
## Scope
36+
37+
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.
38+
39+
## Enforcement
40+
41+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at **contact@poc-innovation.fr**. All complaints will be reviewed and investigated promptly and fairly.
42+
43+
All project leaders are obligated to respect the privacy and security of the reporter of any incident.
44+
45+
## Attribution
46+
47+
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 2.0, available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.

CONTRIBUTING.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,35 @@
1-
# Contributing to [PROJECT'S NAME]
1+
# Contributing to Sensora
22

33
## Create an issue
44

5-
- If you've encountered a bug, open a [Bug Report](https://github.com/PoCInnovation/$REPOSITORY/issues/new?assignees=&labels=&template=bug_report.md&title=).
6-
- If you want [PROJECT'S NAME] to have a new functionality, open a [Feature Request](https://github.com/PoCInnovation/$REPOSITORY/issues/new?assignees=&labels=&template=feature_request.md&title=).
5+
- If you've encountered a bug, open a [Bug Report](https://github.com/PoCInnovation/Sensora/issues/new?assignees=&labels=&template=bug_report.md&title=).
6+
- If you want Sensora to have a new functionality, open a [Feature Request](https://github.com/PoCInnovation/Sensora/issues/new?assignees=&labels=&template=feature_request.md&title=).
77

88
## Resolve an issue
99

10-
Select an [issue](https://github.com/PoCInnovation/$REPOSITORY/issues) that you want to resolve.
10+
Select an [issue](https://github.com/PoCInnovation/Sensora/issues) that you want to resolve.
1111

1212
The recommended workflow is to fork this repository and open pull requests from your fork.
1313

14-
### 1. Fork, clone & configure [PROJECT'S NAME] upstream
14+
### 1. Fork, clone & configure Sensora upstream
1515

1616
- Click on the _Fork_ button on GitHub
1717
- Clone the original repository
1818
- Add your repository as a new remote
1919

2020
```sh
2121
# Clone original repository
22-
git clone git@github.com:PoCInnovation/$REPOSITORY.git
22+
git clone git@github.com:PoCInnovation/Sensora.git
2323

2424
# Add your fork as a remote
25-
git remote add <fork_name> https://github.com/$YOUR_GITHUB_USER/$REPOSITORY.git
25+
git remote add <fork_name> https://github.com/$YOUR_GITHUB_USER/Sensora.git
2626
```
2727

2828
### 2. Create a pull request
2929

3030
```sh
3131
# Create a new branch
32-
git switch -c my_branch
32+
git switch -c <branch name>
3333

3434
# Make changes to your branch
3535
# ...
@@ -40,7 +40,7 @@ git commit -s
4040
# Push your new branch
4141
git push <fork name>
4242

43-
# Create a new pull request from https://github.com/PoCInnovation/$REPOSITORY/pulls
43+
# Create a new pull request from https://github.com/PoCInnovation/Sensora/pulls
4444
```
4545

4646
### 3. Update your pull request with latest changes
@@ -53,7 +53,7 @@ git switch main
5353
git pull
5454

5555
# Switch to your branch
56-
git switch my_branch
56+
git switch <branch name>
5757

5858
# Rebase your branch changes on top of the updated main branch
5959
git rebase main

README.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,34 @@
1-
# 🧠 SenseTouch
1+
# 🧠 Sensora
22

3-
Une interface multisensorielle pour aider les personnes aveugles à percevoir leur environnement grâce à l'IA, au son et au toucher.
3+
A multisensory interface to help blind and visually impaired individuals perceive their environment through AI, sound, and touch.
44

5-
## 📌 Présentation du projet
5+
## 📌 Project Overview
66

7-
SenseTouch est un système innovant destiné à améliorer l'autonomie des personnes aveugles en combinant :
7+
Sensora is an innovative system designed to improve the autonomy of blind people by combining:
88

9-
- des lunettes intelligentes capables d'analyser l'environnement via l'IA,
10-
- et un gant haptique en braille dynamique transmettant l'information par pression.
9+
- smart glasses capable of analyzing the environment via AI,
10+
- and a haptic glove with dynamic braille that transmits information through pressure.
1111

12-
Aujourd'hui, les solutions existantes se limitent principalement aux lunettes connectées et exploitent très peu le sens du toucher, pourtant essentiel chez les personnes non voyantes.
12+
Today, existing solutions are mainly limited to connected glasses and make very little use of the sense of touch, which is essential for visually impaired people.
1313

14-
SenseTouch propose une nouvelle approche : transformer les informations visuelles en retours tactiles et sonores, de manière intuitive et naturelle.
14+
Sensora offers a new approach: transforming visual information into tactile and auditory feedback, in an intuitive and natural way.
1515

16-
## 🎯 Objectifs du projet
16+
## 🎯 Project Goals
1717

18-
- Développer un système sensoriel nouveau et complet pour transmettre l'information.
19-
- Exploiter le toucher via un gant haptique permettant d'activer chaque point braille individuellement.
20-
- Fournir une analyse temps réel de l'environnement grâce à l'IA (objets, obstacles, textes).
21-
- Offrir une communication orale fluide avec l'utilisateur.
22-
- Tester le dispositif avec des utilisateurs non-voyants, encadrés par des experts.
23-
- Concevoir un prototype fonctionnel combinant vision, audio et haptique.
18+
- Develop a new and complete sensory system to transmit information.
19+
- Leverage touch through a haptic glove that can activate each braille point individually.
20+
- Provide real-time environmental analysis using AI (objects, obstacles, texts).
21+
- Offer smooth voice communication with the user.
22+
- Test the device with blind users, supervised by experts.
23+
- Design a functional prototype combining vision, audio, and haptics.
2424

25-
## 🧩 Architecture du système
25+
## 🧩 System Architecture
2626

27-
[À compléter]
27+
[To be completed]
2828

29-
## Get involved
29+
## Get Involved
3030

31-
You're invited to join this project ! Check out the [contributing guide](./CONTRIBUTING.md).
31+
You're invited to join this project! Check out the [contributing guide](./CONTRIBUTING.md).
3232

3333
If you're interested in how the project is organized at a higher level, please contact the current project manager.
3434

@@ -67,6 +67,6 @@ Organization
6767
</a>
6868
</p>
6969
70-
> 🚀 Don't hesitate to follow us on our different networks, and put a star 🌟 on `PoC's` repositories
70+
> 🚀 Feel free to follow us on our social networks and star 🌟 `PoC's` repositories
7171
7272
> Made with ❤️ by PoC

0 commit comments

Comments
 (0)