surfer/README.md
2024-07-06 21:17:06 +02:00

35 lines
1.1 KiB
Markdown

<div align="center">
# Surfer
Build Firefox-based browsers with ease
**This is still in a prerelease / prototype phase. Changes will be made, things will be broken**
</div>
## Installation
```sh
npm install @zen-browser/surfer
```
## Documentation
Documentation is available on [docs.gluon.dev](https://docs.gluon.dev) or in the docs folder of this repository.
## Licencing notes
The following is included in good faith. The writer is not a lawyer, and this is not legal advice.
### Gluon and Melon
Surfer is a fork of [Gluon](https://github.com/pulse-browser/gluon) but the author has stoped working on it. Gluon has been extracted from melon, the build tool for the [desktop version of Dot Browser](https://github.com/dothq/browser-desktop) under MPL v2.0.
This Source Code Form is subject to the terms of the Mozilla Public
License, v. 2.0. If a copy of the MPL was not distributed with this
file, You can obtain one at http://mozilla.org/MPL/2.0/.
### Firefox
This program downloads and modifies Firefox. [Follow their license](https://hg.mozilla.org/mozilla-central/file/tip/LICENSE) when distributing your program.