Skip to content

Improve installation documentation and add optional dependency instructions#26

Open
srimajaya123-blip wants to merge 2 commits intoOSIPI:mainfrom
srimajaya123-blip:improve-readme-installation
Open

Improve installation documentation and add optional dependency instructions#26
srimajaya123-blip wants to merge 2 commits intoOSIPI:mainfrom
srimajaya123-blip:improve-readme-installation

Conversation

@srimajaya123-blip
Copy link

Summary
This PR improves the installation section in the README to make setup clearer and more consistent.
Changes Made

  • Clarified repository cloning and correct folder navigation (cd Method-section-generator/package)
  • Added standard installation instructions (pip install .)
  • Retained editable installation instructions (pip install -e .)
  • Documented optional dependency groups:
    • backend
    • pdf
    • dev
  • Removed duplicated and inconsistent clone instructions

Why This Change Is Needed
The previous installation section only mentioned editable installation and contained inconsistent folder paths. This update:

  • Improves usability for new users
  • Provides clear setup instructions
  • Documents optional dependency groups introduced in recent packaging updates
  • Enhances onboarding experience for contributors

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