Extent clean-up icons script
95
README.md
|
@ -13,6 +13,13 @@ With all the knowledge and new technologies available today. I was inspired by D
|
|||
|
||||
*Note:* This project is still work in progress. However, we have a working [alpha version available](https://gitlab.melroy.org/libreweb/browser/-/releases).
|
||||
|
||||
LibreWeb is:
|
||||
|
||||
- Free and open-source
|
||||
- Decentralized
|
||||
- Censorship resistant
|
||||
- Operating under Windows, Linux (macOS soon)
|
||||
|
||||
## For Users
|
||||
|
||||
### Download
|
||||
|
@ -25,6 +32,28 @@ Just download the latest LibreWeb release and get started:
|
|||
|
||||
Visit the [dedicated documentation site](https://docs.libreweb.org) for *user* documentation.
|
||||
|
||||
### How to Report issues
|
||||
|
||||
**Reporting**
|
||||
|
||||
Create a new issue in [GitLab Issues](https://gitlab.melroy.org/libreweb/browser/-/issues).
|
||||
|
||||
**Supporting**
|
||||
|
||||
If you want to support a certain feature request or same bug that another user already reported, please let us know by using the "thumbs up" button.
|
||||
|
||||
### How to Contribute
|
||||
|
||||
You could help us with:
|
||||
|
||||
- [Documentation](https://docs.libreweb.org)
|
||||
- Discussions on the [Telegram](https://t.me/libreweb) or [Matrix](https://matrix.to/#/#libreweb:melroy.org?via=melroy.org) groups
|
||||
- [Bugs & Feature requests](https://gitlab.melroy.org/libreweb/browser/-/issues)
|
||||
- [Coding](https://gitlab.melroy.org/libreweb/)
|
||||
- [Sponsor us](https://docs.libreweb.org/project/sponsor/)
|
||||
|
||||
[Read more how to contribute](https://docs.libreweb.org/project/contribute/) to the LibreWeb project.
|
||||
|
||||
### Screenshots
|
||||
|
||||
![Browser Screenshot](./misc/browser_screenshot.png)
|
||||
|
@ -38,18 +67,18 @@ Join our [Telegram group](https://t.me/libreweb) or [Matrix channel](https://mat
|
|||
|
||||
The current success criteria:
|
||||
|
||||
* Everyone should be able to easily **read** and **create** a site/blog/news page and publish the content online (without minimal technical knowledge);
|
||||
* Built-in easy-to-use **editor** (whenever you want to publish some content without programming language knowledge);
|
||||
* **Decentralized** (no single-point of failure or censorship), like: P2P, DHT and IPFS;
|
||||
* *No* client-server approach (the client is also the server and visa versa) - think **mesh network**.
|
||||
* **Encrypted** transfers;
|
||||
* Data is stored **redundantly** within the network (no single-point of failure);
|
||||
* **Versioning**/revisions of content and documenents (automatically solves broken 'links', that can't happy anymore);
|
||||
* Publisher user should be able to add additional information about the document/page, eg. title or path (similar in how Jekyll is using the `YML` format for meta data)
|
||||
* Human-readable source-code (eg. `Markdown` format, could be extended as well);
|
||||
* You are in control about the layout and styling (just like with e-books);
|
||||
* Content is King;
|
||||
* Fast and Extensible!
|
||||
- Everyone should be able to easily **read** and **create** a site/blog/news page and publish the content online (without minimal technical knowledge);
|
||||
- Built-in easy-to-use **editor** (whenever you want to publish some content without programming language knowledge);
|
||||
- **Decentralized** (no single-point of failure or censorship), like: P2P, DHT and IPFS;
|
||||
- *No* client-server approach (the client is also the server and visa versa) - think **mesh network**.
|
||||
- **Encrypted** transfers;
|
||||
- Data is stored **redundantly** within the network (no single-point of failure);
|
||||
- **Versioning**/revisions of content and documenents (automatically solves broken 'links', that can't happy anymore);
|
||||
- Publisher user should be able to add additional information about the document/page, eg. title or path (similar in how Jekyll is using the `YML` format for meta data)
|
||||
- Human-readable source-code (eg. `Markdown` format, could be extended as well);
|
||||
- You are in control about the layout and styling (just like with e-books);
|
||||
- Content is King;
|
||||
- Fast and Extensible!
|
||||
|
||||
*Note:* Since HyperText (so is HTML) is not used, you can even ditch the HTTP protocol. However TLS, for encryption, can still be used.
|
||||
|
||||
|
@ -74,11 +103,11 @@ Personally, I'm using VSCodium editor, with the following extensions installed:
|
|||
|
||||
For the **GNU/Linux build** you need at least:
|
||||
|
||||
* GCC 9 or higher (Packages: `build-essential g++-9`)
|
||||
* CMake (Package: `cmake`)
|
||||
* Ninja build system (Package: `ninja-build`)
|
||||
* Libcurl (Package: `libcurl4-openssl-dev`)
|
||||
* GTK3/Gtkmm3 (Package: `libgtkmm-3.0-dev`)
|
||||
- GCC 9 or higher (Packages: `build-essential g++-9`)
|
||||
- CMake (Package: `cmake`)
|
||||
- Ninja build system (Package: `ninja-build`)
|
||||
- Libcurl (Package: `libcurl4-openssl-dev`)
|
||||
- GTK3/Gtkmm3 (Package: `libgtkmm-3.0-dev`)
|
||||
|
||||
**Dependencies for testing:**
|
||||
|
||||
|
@ -169,10 +198,10 @@ We are [**cross-compiling**](https://en.wikipedia.org/wiki/Cross_compiler) towar
|
|||
|
||||
#### Windows Build Dependencies
|
||||
|
||||
* [MXE Gtkmm3 / Curl Binary packages](mxe.cc) (static build using Meson build with GCC11, see below for more info)
|
||||
* CMake (Package: `cmake`)
|
||||
* Ninja (Package: `ninja-build`)
|
||||
* Nullsoft Scriptable Install System (Package: `nsis`)
|
||||
- [MXE Gtkmm3 / Curl Binary packages](mxe.cc) (static build using Meson build with GCC11, see below for more info)
|
||||
- CMake (Package: `cmake`)
|
||||
- Ninja (Package: `ninja-build`)
|
||||
- Nullsoft Scriptable Install System (Package: `nsis`)
|
||||
|
||||
For more information and the latest pre-build GTK3 Windows download, please my other [GTK 3 bundle repo](https://gitlab.melroy.org/melroy/gtk-3-bundle-for-windows).
|
||||
|
||||
|
@ -214,19 +243,19 @@ Build a production release + packaging with [NSIS Installer](https://sourceforge
|
|||
./scripts/build-win-prod.sh
|
||||
```
|
||||
|
||||
For more info, see also: [Windows readme file](windows.md).
|
||||
For more info, see also: [Packaging readme](packaging.md).
|
||||
|
||||
### Apple MacOS / Darwin
|
||||
|
||||
#### MacOS Build Dependencies
|
||||
|
||||
* Xcode (`xcode-select --install`)
|
||||
* Brew (`/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)"`)
|
||||
* CMake (brew: `cmake`)
|
||||
* Libcurl (brew: `curl`)
|
||||
* Gtk3/Gtkmm3 (brew: `gtkmm3`)
|
||||
* GTK Mac Integration (brew: `gtk-mac-integration`)
|
||||
* Ninja (brew: `ninja`)
|
||||
- Xcode (`xcode-select --install`)
|
||||
- Brew (`/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)"`)
|
||||
- CMake (brew: `cmake`)
|
||||
- Libcurl (brew: `curl`)
|
||||
- Gtk3/Gtkmm3 (brew: `gtkmm3`)
|
||||
- GTK Mac Integration (brew: `gtk-mac-integration`)
|
||||
- Ninja (brew: `ninja`)
|
||||
|
||||
#### MacOS Build
|
||||
|
||||
|
@ -234,8 +263,14 @@ We're currently using [GitHub Actions](https://github.com/LibreWeb/Browser/blob/
|
|||
|
||||
*Note:* **Packaging towards MacOS is still in progress**.
|
||||
|
||||
For more info, see also: [Packaging readme](packaging.md)
|
||||
|
||||
## License
|
||||
|
||||
LibreWeb Browser is licensed under [the MIT license](./LICENSE) ([more info](https://choosealicense.com/licenses/mit/)).
|
||||
|
||||
## LibreWeb Research
|
||||
|
||||
For [research document](https://gitlab.melroy.org/libreweb/research_lab/-/blob/master/research.md) plus findings including explanation (like [diagrams](https://gitlab.melroy.org/libreweb/research_lab/-/blob/master/diagrams.md)) see the:
|
||||
|
||||
* [LibreWeb Research Lab Project](https://gitlab.melroy.org/libreweb/research_lab/-/tree/master)
|
||||
- [LibreWeb Research Lab Project](https://gitlab.melroy.org/libreweb/research_lab/-/tree/master)
|
||||
|
|
Before Width: | Height: | Size: 448 B |
Before Width: | Height: | Size: 424 B |
Before Width: | Height: | Size: 510 B |
Before Width: | Height: | Size: 632 B |
Before Width: | Height: | Size: 681 B |
Before Width: | Height: | Size: 753 B |
Before Width: | Height: | Size: 749 B |
Before Width: | Height: | Size: 673 B |
Before Width: | Height: | Size: 831 B |
Before Width: | Height: | Size: 374 B |
Before Width: | Height: | Size: 495 B |
Before Width: | Height: | Size: 436 B |
Before Width: | Height: | Size: 779 B |
Before Width: | Height: | Size: 876 B |
Before Width: | Height: | Size: 724 B |
Before Width: | Height: | Size: 685 B |
Before Width: | Height: | Size: 854 B |
Before Width: | Height: | Size: 851 B |
Before Width: | Height: | Size: 720 B |
Before Width: | Height: | Size: 780 B |
Before Width: | Height: | Size: 826 B |
Before Width: | Height: | Size: 703 B |
Before Width: | Height: | Size: 549 B |
Before Width: | Height: | Size: 847 B |
Before Width: | Height: | Size: 722 B |
Before Width: | Height: | Size: 433 B |
Before Width: | Height: | Size: 552 B |
Before Width: | Height: | Size: 543 B |
Before Width: | Height: | Size: 181 B |
Before Width: | Height: | Size: 646 B |
Before Width: | Height: | Size: 148 B |
Before Width: | Height: | Size: 535 B |
Before Width: | Height: | Size: 176 B |
Before Width: | Height: | Size: 114 B |
Before Width: | Height: | Size: 321 B |
Before Width: | Height: | Size: 193 B |
Before Width: | Height: | Size: 547 B |
Before Width: | Height: | Size: 187 B |
Before Width: | Height: | Size: 645 B |
Before Width: | Height: | Size: 115 B |
Before Width: | Height: | Size: 304 B |
Before Width: | Height: | Size: 185 B |
Before Width: | Height: | Size: 630 B |
Before Width: | Height: | Size: 153 B |
Before Width: | Height: | Size: 310 B |
Before Width: | Height: | Size: 179 B |
Before Width: | Height: | Size: 697 B |
Before Width: | Height: | Size: 115 B |
Before Width: | Height: | Size: 325 B |
Before Width: | Height: | Size: 469 B |
Before Width: | Height: | Size: 308 B |
Before Width: | Height: | Size: 585 B |
Before Width: | Height: | Size: 486 B |
Before Width: | Height: | Size: 435 B |
Before Width: | Height: | Size: 764 B |
Before Width: | Height: | Size: 618 B |
Before Width: | Height: | Size: 783 B |
Before Width: | Height: | Size: 565 B |
Before Width: | Height: | Size: 650 B |
Before Width: | Height: | Size: 692 B |
Before Width: | Height: | Size: 639 B |
Before Width: | Height: | Size: 485 B |
Before Width: | Height: | Size: 652 B |
Before Width: | Height: | Size: 615 B |
Before Width: | Height: | Size: 547 B |
Before Width: | Height: | Size: 500 B |
Before Width: | Height: | Size: 570 B |
Before Width: | Height: | Size: 330 B |
Before Width: | Height: | Size: 797 B |
Before Width: | Height: | Size: 420 B |
Before Width: | Height: | Size: 516 B |
Before Width: | Height: | Size: 674 B |
Before Width: | Height: | Size: 532 B |
Before Width: | Height: | Size: 486 B |
Before Width: | Height: | Size: 465 B |
Before Width: | Height: | Size: 460 B |
Before Width: | Height: | Size: 509 B |
Before Width: | Height: | Size: 459 B |
Before Width: | Height: | Size: 349 B |
Before Width: | Height: | Size: 569 B |
Before Width: | Height: | Size: 658 B |
Before Width: | Height: | Size: 555 B |
Before Width: | Height: | Size: 605 B |
Before Width: | Height: | Size: 255 B |
Before Width: | Height: | Size: 248 B |
Before Width: | Height: | Size: 401 B |
Before Width: | Height: | Size: 781 B |
Before Width: | Height: | Size: 806 B |
Before Width: | Height: | Size: 920 B |
Before Width: | Height: | Size: 824 B |
Before Width: | Height: | Size: 582 B |
Before Width: | Height: | Size: 485 B |
Before Width: | Height: | Size: 465 B |
Before Width: | Height: | Size: 320 B |
Before Width: | Height: | Size: 455 B |
Before Width: | Height: | Size: 442 B |
Before Width: | Height: | Size: 864 B |
Before Width: | Height: | Size: 682 B |
Before Width: | Height: | Size: 299 B |