Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
120 changes: 82 additions & 38 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,71 +1,115 @@
[![Build](https://github.com/sumatrapdfreader/sumatrapdf/actions/workflows/build.yml/badge.svg?branch=master)](https://github.com/sumatrapdfreader/sumatrapdf/actions/workflows/build.yml)
# 📄 PrettySumatraPDF

[![GitHub release](https://img.shields.io/github/v/release/JaviLendi/PrettySumatraPDF?include_prereleases&style=flat-square)](https://github.com/JaviLendi/PrettySumatraPDF/releases)
[![License](https://img.shields.io/github/license/JaviLendi/PrettySumatraPDF?style=flat-square)](LICENSE)
[![GitHub stars](https://img.shields.io/github/stars/JaviLendi/PrettySumatraPDF?style=flat-square)](https://github.com/JaviLendi/PrettySumatraPDF/stargazers)
[![Build](https://img.shields.io/github/actions/workflow/status/JaviLendi/PrettySumatraPDF/build.yml?style=flat-square)](https://github.com/JaviLendi/PrettySumatraPDF/actions)

<div align="center">
<img src="gfx/SumatraPDF-128x128x32.png" alt="PrettySumatraPDF Logo" width="128" height="128">
<h1>PrettySumatraPDF</h1>
</div>

**PrettySumatraPDF** is a modern redesign of the classic SumatraPDF reader, bringing a fresh Windows 11-style interface while maintaining 100% of the original functionality and features.

### What is PrettySumatraPDF?
---

PrettySumatraPDF reimagines the SumatraPDF experience with:
## ✨ Key Features

- **Modern Native UI**: A Windows 11-inspired design philosophy applied to the native Win32 toolbar and interface
- **Zero Functionality Loss**: All original features and capabilities are fully preserved
- **Hybrid Architecture**: Combines native Win32 rendering with optional WebView2 for advanced UI components
- **Clean Aesthetic**: Refined visual design with rounded corners, modern color tokens, and contemporary spacing
- **Performance Focused**: Optimized rendering core maintains the lightweight, fast performance SumatraPDF is known for
- 🚀 **Performance Focused**: Optimized rendering core maintains the lightweight, fast performance SumatraPDF is known for.
- 🎨 **Modern Native UI**: Windows 11-inspired design philosophy applied to the native Win32 toolbar and interface.
- 🌙 **Dark Mode**: A true dark mode, pleasant to the eye and well-integrated with the application.
- 🌐 **Zero Functionality Loss**: All original features and capabilities are fully preserved.
- 📦 **Multi-Format Support**: PDF, EPUB, MOBI, CBZ, CBR, FB2, CHM, XPS, DjVu.
- 📝 **Annotations**: Annotations with saved/unsaved state tracking.
- 🎯 **Advanced Navigation**: Command palette, tabs, bookmarks, table of contents.
- 🔧 **Customization**: Keyboard shortcuts, theme support, settings management.

### Features

PrettySumatraPDF supports all original SumatraPDF formats:
- **Documents**: PDF, EPUB, MOBI, CBZ, CBR, FB2, CHM, XPS, DjVu
- **Editing**: Annotations with saved/unsaved state tracking
- **Navigation**: Command palette, tabs, bookmarks, table of contents
- **Tools**: Text extraction, translation, search, zoom controls
- **Customization**: Keyboard shortcuts, theme support, settings management
---

## Maintanibality and Contributions
## 📸 Screenshots

PrettySumatraPDF is an open-source project licensed under the same terms as SumatraPDF (A)GPLv3, with some code under BSD license. Contributions are welcome! For more information on how to contribute, please visit the [Developer Information](https://www.sumatrapdfreader.org/docs/Contribute-to-SumatraPDF) page.
### Home Screen

My goal with PrettySumatraPDF is to create a visually appealing and modernized version of SumatraPDF while ensuring that all existing features and functionalities remain intact. I am committed to maintaining the core principles of SumatraPDF, including its lightweight nature and fast performance, while enhancing the user experience with a fresh design.
#### Light Theme
![Home Screen - Light Theme](docs/md/img/Home-light.png)

I am committed to update PrettySumatraPDF with the latest features and improvements from the original SumatraPDF project, ensuring that users can enjoy the best of both worlds: a modern interface and the full functionality of the classic reader.
#### Dark Theme
![Home Screen - Dark Theme](docs/md/img/Home-dark.png)

### Screenshots
### Toolbar

#### Home Screen
#### Light Theme
![Toolbar - Light Theme](docs/md/img/Light-pdf.png)

##### Light Theme
#### Dark Theme
![Toolbar - Dark Theme](docs/md/img/Dark-pdf.png)

![Home Screen - Light Theme](img/../docs/md/img/Home-light.png)
---

##### Dark Theme
## 🚀 Download & Installation

Ready to try it out? Head to the releases section to download the latest compiled version:

👉 [**Download PrettySumatraPDF (Latest Release)**](https://github.com/JaviLendi/PrettySumatraPDF/releases)

**Note:** You can use it as a portable application or replace your current SumatraPDF installation.

---

![Home Screen - Dark Theme](img/../docs/md/img/Home-dark.png)
## 🛠️ Build & Development

#### Toolbar
This project is built on top of the official SumatraPDF codebase. If you want to compile it yourself or contribute to visual development, follow these steps:

##### Light Theme
### Requirements

![Toolbar - Light Theme](img/../docs/md/img/Light-pdf.png)
- **Visual Studio** with C++ support
- **Bun** (for build tools) - [Download Bun](https://bun.sh)
- **Clang-Format** (for code formatting)

##### Dark Theme
### Basic Build

![Toolbar - Dark Theme](img/../docs/md/img/Dark-pdf.png)
1. Clone the repository:
```bash
git clone https://github.com/JaviLendi/PrettySumatraPDF.git
cd PrettySumatraPDF
```

2. Run the build:
```bash
bun ./cmd/build.ts
```

3. The executable will be located at: `./out/dbg64/SumatraPDF.exe`

### Debugging

To run with the debugger:
```bash
windbgx -Q -o -g ./out/dbg64/SumatraPDF.exe
```

### Code Formatting

After making changes to `.cpp`, `.c` or `.h` files, run:
```bash
bun ./cmd/format.ts
```

---

## 📖 SumatraPDF Reader
## 🤝 Maintainability & Contributions

PrettySumatraPDF is an open-source project licensed under the same terms as SumatraPDF (A)GPLv3, with some code under BSD license. Contributions are welcome! For more information on how to contribute, please visit the [Developer Information](https://www.sumatrapdfreader.org/docs/Contribute-to-SumatraPDF) page.

My goal with PrettySumatraPDF is to create a visually appealing and modernized version of SumatraPDF while ensuring that all existing features and functionalities remain intact. I am committed to maintaining the core principles of SumatraPDF, including its lightweight nature and fast performance, while enhancing the user experience with a fresh design.

SumatraPDF is a multi-format (PDF, EPUB, MOBI, CBZ, CBR, FB2, CHM, XPS, DjVu) reader
for Windows under (A)GPLv3 license, with some code under BSD license (see
AUTHORS).
I am committed to updating PrettySumatraPDF with the latest features and improvements from the original SumatraPDF project, ensuring that users can enjoy the best of both worlds: a modern interface and the full functionality of the classic reader.

### More Information

* [Website](https://www.sumatrapdfreader.org/free-pdf-reader)
* [Manual](https://www.sumatrapdfreader.org/manual)
* [Developer Information](https://www.sumatrapdfreader.org/docs/Contribute-to-SumatraPDF)
- 🌐 [SumatraPDF Website](https://www.sumatrapdfreader.org/free-pdf-reader)
- 📚 [Manual](https://www.sumatrapdfreader.org/manual)
- 👨‍💻 [Developer Information](https://www.sumatrapdfreader.org/docs/Contribute-to-SumatraPDF)
- 📄 [License](LICENSE)
- ✍️ [Authors](AUTHORS)
Loading