Skip to content

Commit 3b20542

Browse files
committed
Readme fix
1 parent eb165cf commit 3b20542

16 files changed

Lines changed: 30 additions & 5 deletions

File tree

README.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -85,9 +85,13 @@ REACT_APP_WS_PROTOCOL=wss
8585

8686
*Note: Ensure your SSL certificates are generated and placed correctly to allow the browser to trust the local camera stream.*
8787

88-
##UsageOnce the environment is prepared, the system must be awakened manually. The architecture requires the simultaneous operation of the brain (backend) and the eyes (frontend).
88+
## Usage
8989

90-
###Awakening the System1. **Start the Database:** Ensure your MongoDB instance is running locally.
90+
Once the environment is prepared, the system must be awakened manually. The architecture requires the simultaneous operation of the brain (backend) and the eyes (frontend).
91+
92+
### Awakening the System
93+
94+
1. **Start the Database:** Ensure your MongoDB instance is running locally.
9195
2. **Start the Brain:** In your terminal, navigate to the backend directory and launch the secure server:
9296
```bash
9397
python main.py https
@@ -101,11 +105,15 @@ npm start
101105

102106

103107

104-
###The ExperienceUpon launching, the browser will request permission to access the webcam. This is the moment the system begins to observe. Currently, the recognition data—the faces of relatives and friends—must be manually curated in the database (admin phase).
108+
### The Experience
109+
110+
Upon launching, the browser will request permission to access the webcam. This is the moment the system begins to observe. Currently, the recognition data—the faces of relatives and friends—must be manually curated in the database (admin phase).
105111

106112
When a known face appears before the camera, DDFR processes the biometric data and provides immediate text-based feedback on the screen, identifying the person. This text is the precursor to the upcoming "human-like" text-to-speech engine.
107113

108-
##ContributingWe are currently in the phase of solidifying the foundation. The core logic for recognition is complete, and we are not looking for new feature implementations at this moment.
114+
## Contributing
115+
116+
We are currently in the phase of solidifying the foundation. The core logic for recognition is complete, and we are not looking for new feature implementations at this moment.
109117

110118
Our primary need is for **Testers** and **Code Reviewers**.
111119

@@ -114,4 +122,6 @@ Our primary need is for **Testers** and **Code Reviewers**.
114122

115123
If you wish to help polish this digital companion, please verify the code structure and report any inconsistencies.
116124

117-
##LicenseDistributed under the *GPLv3* license. See `LICENSE` for more information.
125+
## License
126+
127+
Distributed under the *GPLv3* license. See `LICENSE` for more information.

docs/models/person.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,4 @@ Person data model with validation and computed fields.
66

77
::: app.models.person.Person
88

9+

docs/scripts/insertdata.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,4 @@ Utility script for inserting demo person data into the database.
88

99
::: app.insertdata.main
1010

11+

docs/services/database.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,4 @@ MongoDB database service for person data management.
66

77
::: app.services.database.Database
88

9+

docs/services/recognition.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,4 @@ Face detection and recognition engine using InsightFace and FAISS.
66

77
::: app.services.recognition.FaceEngine
88

9+

docs/utils/constants.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,3 +10,4 @@ Enumeration types for the application.
1010

1111
::: app.utils.constants.RoleType
1212

13+

docs/utils/img.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,4 @@ Image validation and conversion utility.
66

77
::: app.utils.img.ImgValidation
88

9+

frontend/src/components/CameraToggle.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,3 +23,4 @@ export default React.memo(CameraToggle);
2323

2424

2525

26+

frontend/src/components/DebugInfo.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,3 +46,4 @@ export default DebugInfo;
4646

4747

4848

49+

frontend/src/components/FaceBox.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,3 +65,4 @@ export default React.memo(FaceBox, (prevProps, nextProps) => {
6565

6666

6767

68+

0 commit comments

Comments
 (0)