READMEBuilder 4.2.0

All new changes

1. Smart Shortcuts

   • H1/H2/H3: Alt+& / Alt+é / Alt+" — transforms current line or selection into a heading
   • F3: Insert <img> tag
   • F4: <h1 align="center"> — wraps selection in centered heading
   • F5/F6/F7: <p align="left/center/right">
   • F8: - **bold** — each selected line becomes a bold bullet
   • F9: > [!NOTE] alert
   • F10: code block with ```bash
   • Ctrl+& / Ctrl+é / Ctrl+" / Ctrl+': tables (2/3/4 columns + aligned)
   • All are smart: if text is selected, it transforms it; if not, it applies to the current line.

2. Preview Fix

   • Removed all auto-scrolling — preview only moves when you manually scroll
   • Save and restore scrollbar position around setHtml (QTextBrowser is synchronous, so no flicker)
   • Added line numbers to the preview using CSS counters for visual reference

3. Canvas Centering

   • When opening the canvas, camera auto-centers on all nodes and adjusts zoom to fit

4. PDF Export

   • Export dialog now includes PDF (*.pdf) alongside HTML and Markdown
   • Uses QPrinter with A4 page size and 20mm margins

5. Single Instance

   • Opening a .md file from Explorer opens in the same running app instance as a new tab
   • Uses QLocalServer/QLocalSocket — the second instance sends the file path and exits

6. Key Binding Fix

   • Changed from Qt.Key_1/Qt.Key_2/Qt.Key_3 to actual AZERTY characters &, é, ", ' so the top-row keys work correctly

7. Fix -Removed: TOC - Score - Social - Translate - Repair

Shortcuts

Shortcuts	action
H1	Alt+&
H1	Alt+é
H3	Alt+
F3	Insert <img> tag
F4	h1 align="center
F7	align="left
F8	align="center
F9	align="right
F10	Cell
Ctrl+&	tables1
Ctrl+é	tables2
Ctrl+"	tables3
Ctrl+'	tables4
Ctrl+r	open canvas
Ctrl+t	quick template
Ctrl+w	close tab
Ctrl+n	new tab
Ctrl+f	find

How to Use

The program is very easy to use. Just move it to the C: drive inside a folder named README (or any name you prefer). When you run it for the first time from that path, the program will automatically integrate with your system. After that, you can easily use it to open existing README files or create new ones.

---

README 4.1.0

New version 4.1.0

README 4.1.0 consists of two versions:

4.1.0 Lite (No AI ) - 10x Faster.

4.1.0 AI (Opening is slower because it needs to start the server and connect to the model within README 4.1.0.exe).

README 4.1.1 ([DOWNLOAD READMEBuilder - FIX - Stable Version])

DOWNLOAD READMEBuilder - FIX - Stable Version

Images

AI version	Lite version

Installation

1. Clone:

git clone https://github.com/YASSER-27/README-Builder

Python README_LITE_4.1.0.py

Download

Lite version

AI version

How to Use

The program is very easy to use. Just move it to the C: drive inside a folder named README (or any name you prefer). When you run it for the first time from that path, the program will automatically integrate with your system. After that, you can easily use it to open existing README files or create new ones.

---

README Builder v4.0.1

README Builder

207 MB (webengine)

---

Image	Image

README Builder v4.0.0.

README Builder Pro is a high-performance, professional Markdown editor specifically designed for creating stunning GitHub READMEs. It features a real-time high-fidelity preview, AI-powered content generation, and seamless Windows integration.

README Builder 66.1 MB

## Instant Deployment (Windows)

Important

When you run the application for the first time, it automatically performs a Self-Installation:

1. It copies the executable to your local profile: %LOCALAPPDATA%\Programs\READMEBuilder
2. It creates a "README Builder" shortcut on your Desktop.
3. It registers itself in the Windows Context Menu (Right-click).

This ensures the program is always accessible and performs optimally from a stable location.

Key Features

• Fidelity Preview: Real-time rendering with GitHub-standard styling.
• Templates: 15+ professional templates (Web App, CLI, Mobile, Game, etc.) with live preview.
• AI Integration: Built-in AI assistant to improve structure, translate, or auto-complete your README.
• Windows Integration:
  • Open with README Builder: Right-click any file to edit.
  • Create README here: Right-click folder background to start a new project instantly.
• Toolkit: Built-in Image Manager, Table Generator, Badge Library, and Automatic TOC generation.
• Performance: Native PySide6 implementation for near-instant startup and smooth editing.

Shortcuts

Shortcut	Action
Ctrl + N	New Tab
Ctrl + S	Quick Save
Ctrl + T	Open Templates
Ctrl + I	Image Manager
Ctrl + F	Find
F1	Save Selection as Snippet
F2	Rename Current Tab

🤝 Contributing

Contributions are welcome! Feel free to fork the repository and submit pull requests.

📄 License

This project is licensed under the MIT License.

---

README Builder 3.0.0

README Builder

📸 Screenshots

Preview 1	Preview 2

🎥 Demo Video

readme.mp4

README Builder Downlaod Now Free And Open source HERE

🛠 Installation

1. Download And Extract: Extract the README Builder ZIP file directly into your C:\ drive (e.g., C:\README-Builder).
2. Add Environment Path: Add the C:\README-Builder folder to your system's Environment Variables (Path). This enables the global readme command from any directory.
3. Run add_context_menu.reg.
4. Now right-click > Open with > README Or Instant Access: In any folder's Address Bar, simply type readme and press Enter to launch the editor instantly.

for remove readme from right-click go to RUN and regedit and (Computer\HKEY_CLASSES_ROOT\Directory\Background\shell) and remove folder readme

---

Context Menu: Run add_context_menu.reg to add the "Open with README Builder" option to your right-click menu.

Environment Variable (Optional): Add the program path to your system's Path to enable the global readme command.

🛠️ How to Use? Navigate to any project folder on your PC.

Type readme in the folder's address bar or right-click and select the builder.

Start typing and watch your documentation come to life instantly!

Done! ✅