Skip to content

Clarify README positioning#40

Merged
novis10813 merged 1 commit into
mainfrom
docs/clarify-readme
Jun 10, 2026
Merged

Clarify README positioning#40
novis10813 merged 1 commit into
mainfrom
docs/clarify-readme

Conversation

@novis10813

Copy link
Copy Markdown
Owner

Summary

  • Sharpen the project positioning for Factorium
  • Add a clearer audience/use-case paragraph
  • Keep installation, quick example, docs, status, and license easy to scan

Notes

Docs-only change.

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Code Review

This pull request updates the README.md to improve the project description, restructure the feature list, add a Status section, and refine the documentation links. The reviewer suggested changing the installation command from 'uv add factorium' to 'uv pip install factorium' to prevent errors for users who do not have a pyproject.toml file in their environment.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Comment thread README.md

```bash
# Recommended
uv add factorium

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

Using uv add factorium is intended for adding a dependency to an existing uv project (which requires a pyproject.toml file). For general users who simply want to install the package in a virtual environment or a Jupyter notebook, uv pip install factorium is the standard command and prevents "No pyproject.toml found" errors.

Suggested change
uv add factorium
uv pip install factorium

@novis10813 novis10813 merged commit 33381a1 into main Jun 10, 2026
3 checks passed
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.

1 participant