tcsenpai/screenshot-timeline
1
0
Fork 0
mirror of https://github.com/tcsenpai/screenshot-timeline.git synced 2025-06-03 01:40:12 +00:00
Code Issues Packages Projects Releases Wiki Activity

updated readme

Browse Source
This commit is contained in:
tcsenpai 2024-08-22 18:10:27 +02:00
parent 412af2c8ec
commit 90bd159a77
3 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
.gitignore vendored
View File

@ -16,4 +16,5 @@ __pycache__
.env.development
.env.development.local
.env.test
.env.test.local
.env.test.local
static/screenshots/screenshots_will_be_added_here

6
README.md
View File

@ -1,5 +1,7 @@
# Screenshot Timeline
![Preview](preview.png)
A work in progress privacy focused alternative to Microsoft Copilot and similar spyware.
Screenshot Timeline is an automated screenshot capture and analysis tool that uses OCR to extract text from images and organize them with tags for easy searching and filtering.
@ -88,8 +90,8 @@ We welcome contributions to the Screenshot Timeline project! If you'd like to co
1. Fork the repository on GitHub.
2. Create a new branch with a descriptive name for your feature or bug fix.
3. Make your changes, ensuring you follow the project's coding style and conventions.
4. Add or update tests as necessary to cover your changes.
5. Ensure all tests pass by running the test suite.
4. Document your changes
5. Ensure all works by running the code on your machine
6. Commit your changes with a clear and descriptive commit message.
7. Push your branch to your fork on GitHub.
8. Open a pull request against the main repository's `main` branch.

BIN
preview.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 372 KiB