Clarify README positioning#40
Conversation
There was a problem hiding this comment.
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.
|
|
||
| ```bash | ||
| # Recommended | ||
| uv add factorium |
There was a problem hiding this comment.
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.
| uv add factorium | |
| uv pip install factorium |
Summary
Notes
Docs-only change.