diff options
author | Roger <sachanroger@gmail.com> | 2019-08-29 00:21:53 +0000 |
---|---|---|
committer | Michael Catanzaro <mcatanzaro@gnome.org> | 2019-08-30 20:14:23 +0000 |
commit | 803f889e77372894e631d3369684a605df63f7c3 (patch) | |
tree | 49527b8d2a9e823c47eb9bb150e28063a223ea24 /README.md | |
parent | b90cc7b0ec3d1413356145b3d7f2e1c5454d5597 (diff) | |
download | epiphany-803f889e77372894e631d3369684a605df63f7c3.tar.gz |
Use only one primary header
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 32 |
1 files changed, 17 insertions, 15 deletions
@@ -1,3 +1,5 @@ +# GNOME Web + GNOME Web (codename: Epiphany) is a GNOME web browser based on [the WebKit rendering engine](https://webkit.org/). The codename means "a usually sudden manifestation or perception of the essential nature or meaning of @@ -5,7 +7,7 @@ something" ([Merriam-Webster](https://www.merriam-webster.com/dictionary/epiphan Epiphany is opinionated. -# Download and Install +## Download and Install Epiphany is designed for Linux systems. The recommended way to install Epiphany is via [Flatpak](https://www.flatpak.org/). You may: @@ -22,9 +24,9 @@ Epiphany is probably also available via your operating system's package manager, but such packages are often outdated and insecure. Flatpak is the best application distribution mechanism for Linux. -# Building from Source +## Building from Source -## The Easy Way +### The Easy Way The recommended way to build Epiphany locally is using the flatpak-builder manifest with GNOME Builder. After installing Builder and launching it, you'll @@ -33,7 +35,7 @@ directory. Builder will detect the org.gnome.Epiphany.json flatpak-builder manifest and you will be able to build the project in Builder. All required dependencies will be provided by the manifest. -## Building Manually +### Building Manually Epiphany uses the [Meson build system](http://mesonbuild.com/). You can build Epiphany the same way you would any software that uses Meson. For example: @@ -64,19 +66,19 @@ $ sudo dnf install 'pkgconfig(hogweed)' In other distributions, you must research each dependency to determine which package provides the required pkg-config file. -## Rebuilding Dependencies +### Rebuilding Dependencies If you need to rebuild dependencies, the recommended solution is to use JHBuild. See [the development page](https://wiki.gnome.org/Apps/Web/Development#Step_3:_Developing_Dependencies_with_Epiphany) for more information. -# Manifesto +## Manifesto A web browser is more than an application: it is a way of thinking, a way of seeing the world. Epiphany's principles are simplicity, standards compliance, and software freedom. -## Simplicity +### Simplicity Feature bloat and user interface clutter is evil. @@ -86,7 +88,7 @@ too big, buggy, and bloated. Epiphany is a small browser designed for the web: not for mail, newsgroups, file management, instant messaging, or coffeemaking. The UNIX philosophy is to design small tools that do one thing and do it well. -## Standards Compliance +### Standards Compliance The introduction of nonstandard features in browsers could make it difficult or impossible to use alternative products like Epiphany if developers embrace @@ -97,7 +99,7 @@ ultimately lead one browser to dominate the market. Standards compliance ensures the freedom of choice. Epiphany aims to achieve this. -## Software Freedom +### Software Freedom Epiphany is not just free of cost; more importantly, the source code is made available to you under a license that [respects your freedom](https://www.gnu.org/philosophy/philosophy.html). @@ -108,25 +110,25 @@ offender is Google Chrome, a browser that purports to be open source, yet actually includes several proprietary components. In contrast, Epiphany is fully free software. -# Human Interface +## Human Interface Epiphany follows the [GNOME Human Interface Guidelines](https://developer.gnome.org/hig/stable/). Unless there are serious reasons to make an exception, not following the guidelines will be considered a bug. -## GNOME Integration +### GNOME Integration Epiphany's main goal is to be integrated with GNOME, as well as similar desktops (notably elementary OS). We don't aim to make Epiphany usable outside these environments. -## Preferences +### Preferences We are cautious about adding new preferences. Preferences can be added when they make sense, but they should always be carefully-considered. [Preferences come with a cost](https://ometer.com/preferences.html). -## Target Audience +### Target Audience We target nontechnical users by design. This happens to be 90% of the user population. Technical details should not exposed in the interface. @@ -134,12 +136,12 @@ population. Technical details should not exposed in the interface. We target web users, not web developers. A few geek-oriented features, like the web inspector, are welcome so long as they are non-obtrusive. -# Website +## Website [Epiphany has a website,](https://wiki.gnome.org/Apps/Web) though there is not very much content there. -# Contact Us +## Contact Us The recommended way to contact us is via the Epiphany mailing list <epiphany-list@gnome.org>. |