Files
desktop/README.md
2024-08-14 10:42:04 +02:00

75 lines
1.5 KiB
Markdown

# 🌀 Zen Browser
Experience tranquillity while browsing the web without people tracking you!
* [Website](https://www.zen-browser.app)
* [Download](https://www.zen-browser.app/download)
* [Release Notes](https://www.zen-browser.app/release-notes/latest)
<a href='https://flathub.org/apps/io.github.zen_browser.zen'>
<img width='240' alt='Get it on Flathub' src='https://flathub.org/api/badge?locale=en'/>
</a>
# Compatibility
Zen is currently built using firefox version `129.0`!
* Checkout the latest [releases notes](https://www.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](./docs/performance.md)!
## 🚀 Run Locally
Clone the project
```bash
git clone https://github.com/zen-browser/desktop.git
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)
- [Erlend](https://havn.blog) (For making the logo)
- [ptr1337](https://github.com/ptr1337) (AUR Packages and optimization flags)
## Third Party Code
Zen coudn'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)