mirror of
https://github.com/zen-browser/desktop.git
synced 2025-12-24 07:08:52 +00:00
134 lines
3.5 KiB
Markdown
134 lines
3.5 KiB
Markdown
<div align="center">
|
|
<picture>
|
|
<img src="./docs/assets/zen-black.svg" width="128px">
|
|
</picture>
|
|
</div>
|
|
<h1 align="center">
|
|
Zen Browser
|
|
</h1>
|
|
|
|
Experience tranquillity while browsing the web without people tracking you!
|
|
|
|
- [Website](https://zen-browser.app)
|
|
- [Download](https://zen-browser.app/download)
|
|
- [Release Notes](https://zen-browser.app/release-notes/latest)
|
|
|
|
[](https://github.com/zen-browser/desktop/releases)
|
|
[](https://crowdin.com/project/zen-browser)
|
|
|
|
[](https://flathub.org/apps/io.github.zen_browser.zen)
|
|
|
|
[](https://www.patreon.com/zen_browser)
|
|
|
|
[](https://ko-fi.com/zen_browser)
|
|
|
|
# Compatibility
|
|
|
|
Zen is currently built using firefox version `130.0`!
|
|
|
|
- Check out the latest [release notes](https://zen-browser.app/release-notes)!
|
|
|
|
# Performance
|
|
|
|
Zen is built with performance in mind, and we have optimized the browser to be as fast as possible!
|
|
|
|
- Checkout the latest [performance benchmarks](https://docs.zen-browser.app/benchmarks)!
|
|
|
|
# Installation
|
|
|
|
## Supported Operating Systems
|
|
|
|
Zen is available for Linux, macOS, and Windows. You can download the latest version from the official website at [zen-browser.app](https://zen-browser.app/download), or from the [GitHub Releases](https://github.com/zen-browser/desktop/releases) page.
|
|
|
|
### macOS
|
|
|
|
- Requires macOS 10.15 or later
|
|
- Available for ARM and Intel architectures
|
|
|
|
You can also install Zen using Homebrew:
|
|
|
|
```
|
|
brew install --cask zen-browser
|
|
```
|
|
|
|
### Linux
|
|
|
|
#### AppImage
|
|
|
|
- `zsync` is required for the Update feature of the script below
|
|
|
|
```
|
|
bash <(curl https://updates.zen-browser.app/appimage.sh)
|
|
```
|
|
|
|
#### Flatpak
|
|
```
|
|
flatpak install flathub io.github.zen_browser.zen
|
|
```
|
|
|
|
To upgrade the browser to a newer version, use the embedded update functionality in `About Zen`.
|
|
|
|
# Core Components
|
|
|
|
Some components used by @zen-browser as an attempt to make firefox forks a better place. You can find them [here](https://github.com/zen-browser/components).
|
|
|
|
## 🚀 Run Locally
|
|
|
|
Clone the project
|
|
|
|
```bash
|
|
git clone https://github.com/zen-browser/desktop.git --recurse-submodules
|
|
cd desktop
|
|
```
|
|
|
|
Install dependencies
|
|
|
|
```bash
|
|
npm i
|
|
```
|
|
|
|
Download and bootstrap the browser
|
|
|
|
```
|
|
npm run init
|
|
```
|
|
|
|
Start building the browser
|
|
|
|
```
|
|
npm run build
|
|
```
|
|
|
|
Finally, run the browser!
|
|
|
|
```
|
|
npm start
|
|
```
|
|
|
|
## Special Thanks
|
|
|
|
- [IAmJafeth](https://github.com/IAmJafeth) (For sponsoring the domain)
|
|
- [Donno 🐒](https://www.onnno.nl/) (For making the logo)
|
|
- [ptr1337](https://github.com/ptr1337) (AUR Packages and optimization flags)
|
|
- [nitro](https://github.com/n7itro) (For the amazing work on the browser)
|
|
|
|
## Third Party Code
|
|
|
|
Zen couldn't be in its current state without the help of these amazing projects!
|
|
|
|
- Zen's default preferences are based on [BetterFox](https://github.com/yokoffing/Betterfox)
|
|
|
|
## License
|
|
|
|
[MPL LICENSE](./LICENSE)
|
|
|
|
## Star History
|
|
|
|
<a href="https://star-history.com/#zen-browser/desktop&Date">
|
|
<picture>
|
|
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=zen-browser/desktop&type=Date&theme=dark" />
|
|
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=zen-browser/desktop&type=Date" />
|
|
<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=zen-browser/desktop&type=Date" />
|
|
</picture>
|
|
</a>
|