Skip to content

Simplify the README - #357

Merged
Mathieu2301 merged 1 commit into
mainfrom
docs/readme-minimal
Nov 14, 2026
Merged

Mathieu2301 merged 1 commit into
mainfrom
docs/readme-minimal

Conversation

@Mathieu2301

Copy link
Copy Markdown
Owner

Simplifies the README in English, French, Spanish and Portuguese: a short pitch, a help link, the feature list, the install command and links to the docs.

  • Installation details, the interactive quick-start, accounts and limits, and contributing move to the new docs/getting-started.md. Nothing is lost.
  • The unused demo GIF is removed.
  • The docs/backtest.md link to Accounts and limits now points to the new page.

Shorter README in every language: a short pitch, the help link, the feature list, the install command and the doc links. Setup details move to docs/getting-started.md; the unused demo GIF is removed.
@Mathieu2301
Mathieu2301 merged commit c933e82 into main Nov 14, 2026
12 checks passed
@Mathieu2301 Mathieu2301 mentioned this pull request Nov 14, 2026
Mathieu2301 added a commit that referenced this pull request Nov 14, 2026
Documentation release: simpler README (#357). No code change.
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