Draft
[Docs] - Add Quick Start section to README answering "How to run this project"#1
Conversation
Agent-Logs-Url: https://github.com/sds-web26/OpenBB/sessions/be99fccc-be44-415d-abf7-1360db5da474 Co-authored-by: sds-web26 <267427860+sds-web26@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Add instructions for running the project
[Docs] - Add Quick Start section to README answering "How to run this project"
Mar 31, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Users lacked a clear, consolidated entry point for running OpenBB — installation info existed but was scattered with no dedicated "how to run" section.
What
Added a Quick Start section (§1) to the root
README.mdcovering the three primary run modes:pip install openbb+ minimal usage snippetpip install "openbb[all]"+openbb-api, with server/docs URLspython dev_install.py -e→ verificationAlso updated the Table of Contents and renumbered all downstream sections (§1–§7 → §2–§8).
Impact
Documentation-only change. No code, logic, or runtime behavior affected. Impact score: 1
Testing Done
Reviewed rendered Markdown structure; verified section anchors in ToC match new headings.