Skip to content

Arabic on the main README; detailed requirements and a step-by-step guide - #17

Merged
wJubran merged 1 commit into
mainfrom
claude/sharp-wozniak-49jry7
Oct 17, 2026
Merged

wJubran merged 1 commit into
mainfrom
claude/sharp-wozniak-49jry7

Conversation

@wJubran

@wJubran wJubran commented Oct 17, 2026

Copy link
Copy Markdown
Owner

What and why

The repository's main page only linked to the Arabic README, and both READMEs went from "install Python" straight to four commands. This PR:

  • Arabic on the main page. README.md gets a short Arabic summary under the header, linked to a full Arabic section after the English text. That section covers what the project is, its main features, the requirements, step-by-step installation and running, and troubleshooting.

  • Requirements table, in English and Arabic. It covers the OS, Python (64-bit, 3.10+, tested on 3.10, 3.12 and 3.13), memory, disk, browser and internet, plus the optional MetaTrader 5, Node.js and Git.

  • Step-by-step guide, in both languages:

    1. Install Python.
    2. Get the code (git or ZIP).
    3. Create a virtual environment in the project folder, which is where the desktop app looks for it.
    4. Install the dependencies.
    5. Run on the simulator, or with MetaTrader 5: Algo Trading for orders, and TERMINAL PATH or LOGIN CREDENTIALS when it isn't found on its own.
    6. First steps in the terminal.
    7. Stop, restart, update and uninstall.

    It also covers the desktop app and has a troubleshooting table.

  • The Arabic README has the same sections in place of its old two-minute section and separate desktop-app section.

The numbers come from a measured run:

  • the backend uses about 135 MB on the simulator;
  • the dependencies take about 470 MB;
  • the first cone build takes about 30 seconds.

MetaQuotes publishes MetaTrader5 wheels only for 64-bit Windows, for Python 3.10–3.14, so the guide asks for 64-bit Python. The Arabic wording is chosen to avoid right-to-left rendering glitches, such as "bit-64" or brackets jumping around English commands.

How it was tested

  • Rendered both READMEs with cmark-gfm (GitHub's Markdown engine) and GitHub's stylesheet, and checked the English and Arabic sections in screenshots. Anchors, tables, code blocks and right-to-left text render correctly.
  • Checked every UI label quoted in the guide against the source (Settings → TRADING → LIVE TRADING, PROVIDERS → TERMINAL PATH / LOGIN CREDENTIALS) and every log message quoted (MT5 initialize() failed).
  • python -m pytest tests/test_branding.py passes.
  • UI changes: none.

Screenshots

Docs only.


Generated by Claude Code

…step guide

- README.md gets an Arabic summary under the header, and a full Arabic section
  after the English text that covers what the project is, its features, its
  requirements, step-by-step installation and running, and troubleshooting.
- Both READMEs now have:
  - a requirements table with OS, Python (64-bit, 3.10+, tested on 3.10, 3.12
    and 3.13), memory, disk, browser, internet, and the optional MetaTrader 5,
    Node.js and Git;
  - a step-by-step guide: install Python, get the code, create a virtual
    environment in the project folder (where the desktop app looks for it),
    install the dependencies, run on the simulator or with MetaTrader 5 (Algo
    Trading for orders, TERMINAL PATH / LOGIN CREDENTIALS), first steps, and
    stop / restart / update / uninstall;
  - the desktop app instructions and a troubleshooting table.
- The numbers come from a measured run: the backend uses about 135 MB on the
  simulator, the dependencies take about 470 MB, and the first cone build takes
  about 30 seconds. MetaQuotes publishes MetaTrader5 wheels only for 64-bit
  Windows, for Python 3.10 to 3.14.
- The Arabic wording avoids right-to-left rendering glitches, such as
  "bit-64" and stray brackets around English commands.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01649i4SjUGvhXrPV3AiNhHN
@wJubran
wJubran merged commit 1cc4e2b into main Oct 17, 2026
6 checks passed
wJubran added a commit that referenced this pull request Oct 18, 2026
…uide (#17)

README.md gets a short Arabic summary under the header and a full Arabic section after the English text. That section covers what the project is, its features, its requirements, step-by-step installation and running, and troubleshooting. Both READMEs now have a requirements table and a step-by-step guide that covers Python, a virtual environment, the simulator or MetaTrader 5, updating, the desktop app and troubleshooting.
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.

2 participants