Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation #5

Merged
merged 3 commits into from
Dec 24, 2024
Merged

Update documentation #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8b584e9
Add documentation
vbossica Dec 24, 2024
1b81fb0
Update documentation
vbossica Dec 24, 2024
71664ff
resize
vbossica Dec 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion .vscode/settings.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@
"python.analysis.inlayHints.functionReturnTypes": true,
"python.analysis.inlayHints.pytestParameters": false,
"cSpell.words": [
"logmodule"
"logmodule",
"résumés",
"venv"
]
}
15 changes: 14 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,16 @@
# Cyrano

Cyrano is an AI agent that optimizes résumés.
Cyrano de Bergerac, the titular character in Edmond Rostand's play, is a masterful wordsmith renowned for his eloquence, wit, and ability to craft beautiful and persuasive texts. His dedication to his craft is evident in his meticulous attention to detail.

Were he alive today, Cyrano would undoubtedly harness the power of AI to craft compelling résumés.

## Overview

The tooling is written in Python and leverages the Azure AI Foundry offering.

![overview](docs/.media/overview.png)

Here are a couple of links to get you started:

* [Installation and configuration](/docs/installation.md)
* Some [recipes](/docs/recipes.md)
Loading
Loading