Skip to content

Update README#11

Open
pablosuvi wants to merge 2 commits into
mainfrom
4-add-readme
Open

Update README#11
pablosuvi wants to merge 2 commits into
mainfrom
4-add-readme

Conversation

@pablosuvi

Copy link
Copy Markdown
Collaborator

Update README, with basic structure. More details will be added down the line.

@pablosuvi pablosuvi linked an issue Jul 24, 2026 that may be closed by this pull request

@jimnel jimnel left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One typo

Comment thread README.md Outdated
uv sync
\`\`\`

> Note: `qkernel4eo` is installed directly from its private GitHub repo over SSH, so make sure your SSH key is set up with GitHub before running `uv sync`.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
> Note: `qkernel4eo` is installed directly from its private GitHub repo over SSH, so make sure your SSH key is set up with GitHub before running `uv sync`.
> Note: `qkernel` is installed directly from its private GitHub repo over SSH, so make sure your SSH key is set up with GitHub before running `uv sync`.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That line is inteded to be referring to qkernel4eo package, which is one of the dependancies in .toml file, and not to the qkernel itself. I added some text for some clarification

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add ReadMe

2 participants