aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorPriit Laes <plaes@plaes.org>2009-07-22 15:43:34 +0800
committerPriit Laes <plaes@plaes.org>2009-07-22 15:57:21 +0800
commit8c9f8e984de0cd430f53140b816c476cf7e9dc67 (patch)
treea9877ccc31f2e62ab67d24edb447f00d560f73a8
parent65b9077bd1eedc7a32279990638f0e98e3d9563d (diff)
downloadgsoc2013-epiphany-8c9f8e984de0cd430f53140b816c476cf7e9dc67.tar.gz
gsoc2013-epiphany-8c9f8e984de0cd430f53140b816c476cf7e9dc67.tar.zst
gsoc2013-epiphany-8c9f8e984de0cd430f53140b816c476cf7e9dc67.zip
Update various outdated documents.
ChangeLog.README, HACKING, README, TODO: Updates, spelling fixes, etc. Signed-off-by: Priit Laes <plaes@plaes.org>
-rw-r--r--ChangeLog.README4
-rw-r--r--HACKING5
-rw-r--r--README59
-rw-r--r--TODO7
4 files changed, 30 insertions, 45 deletions
diff --git a/ChangeLog.README b/ChangeLog.README
index 092d054be..4a4294aa2 100644
--- a/ChangeLog.README
+++ b/ChangeLog.README
@@ -1,7 +1,7 @@
-Epiphany doesn't use ChangeLog anymore. Instead, we use SVN checkin comments
+Epiphany doesn't use ChangeLog anymore. Instead, we use Git checkin comments
to autogenerate a ChangeLog file at "make dist" time.
-When committing a patch to svn, you must use a checkin comment that fully
+When committing a patch to git, you must use a checkin comment that fully
describes the changes made. If the checkin is related to a bug, reference
the bug number. Example:
diff --git a/HACKING b/HACKING
index 57cd9bf9b..a768611d8 100644
--- a/HACKING
+++ b/HACKING
@@ -15,12 +15,13 @@ need to stick to in order to get your patch accepted:
uncrustify program to get correct indentation in new files.
Comment blocks are written like this:
-
+
/*
* bla_bla_cb: This is an example comment block
*/
-See ChangeLog.README for SVN checkin rules.
+See ChangeLog.README for Git checkin rules.
+See doc/debugging.txt for some tips and tricks for debugging.
Do NOT commit to this module without permission from a maintainer.
See the MAINTAINERS file for who they are.
diff --git a/README b/README
index e560cddf0..866290c3c 100644
--- a/README
+++ b/README
@@ -1,7 +1,6 @@
-Epiphany is a GNOME web browser based on the mozilla
-rendering engine.
+Epiphany is a GNOME web browser based on the WebKit rendering engine.
The name meaning:
-"An intuitive grasp of reality through
+"An intuitive grasp of reality through
something (as an event) usually simple and striking"
MANIFESTO
@@ -12,11 +11,6 @@ compliance.
Simplicity:
-While Mozilla has an excellent rendering engine, its default
-XUL-based interface is considered to be overcrowded and bloated. Furthermore,
-on slower processors even trivial tasks such as pulling down a menu is less
-than responsive.
-
Epiphany aims to utilize the simplest interface possible for a browser. Keep
in mind that simple does not necessarily mean less powerful. We believe
the commonly used browsers of today are too big, buggy, and bloated. Epiphany
@@ -27,17 +21,17 @@ philosophy is to design small tools that do one thing, and do it well.
Epiphany also address simplicity with modularity to make a light and powerful
application. If something can be implemented using external applications
or components, we use it rather than wasting resources in the web browser.
-Integration will be achived with CORBA, Bonobo, and the ever popular
-command line.
+Integration with other desktop applications can also be achieved using DBus
+and the ever popular command line.
-Mail will be handled with your favorite e-mail application (Evolution, pine,
-mutt, balsa, pronto, whatever).
+Other tasks like mail can be handled with your favorite e-mail application
+(Evolution, pine, mutt, balsa, pronto, whatever).
Standards compliance:
The introduction of non-standard features in browsers could make it difficult
or impossible to use alternative products like Epiphany if developers embrace
-them. Alternative (standards complying) browsers could not be able to
+them. Alternative (standards complying) browsers could not be able to
fully access web sites making use of these features. The success of
non-standard features can ultimately lead to forcing one browser, on
one platform to dominate the market.
@@ -49,19 +43,19 @@ USER INTERFACE LINES
- HIG compliance
-Epiphany is going to follow version 1.0 of the gnome
-user guidelines. Unless there are very seriuos reasons to make an
-exception not following it will be considered a bug.
-"I follow the HIG only when I like it" is not a legitimate approach.
-Any areas where we diverge from the HIG will communicated
+Epiphany is going to follow latest version of the GNOME Human Interface
+Guidelines. Unless there are very serious reasons to make an exception not
+following it will be considered a bug.
+"I follow the HIG only when I like it" is not a legitimate approach.
+Any areas where we diverge from the HIG will communicated
to the HIG team for future consideration.
-- Gnome integration
+- GNOME integration
-Epiphany's main goal is to be integrated with the gnome desktop.
-We dont aim to make epiphany usable outside Gnome. If someone will like
-to use it anyway, it's just a plus. Ex: Making people happy that
-don't have control center installed is not a good reason
+Epiphany's main goal is to be integrated with the GNOME desktop.
+We dont aim to make epiphany usable outside GNOME. If someone will like
+to use it anyway, it's just a plus. Ex: Making people happy that
+don't have control center installed is not a good reason
to have mime configuration in epiphany itself.
- Simple design
@@ -70,33 +64,30 @@ Feature bloat and user interface clutter is evil :)
- Preferences
-We will follow the new gnome policy about preferences.
-I think Havoc Pennington already explained it a lot
+We will follow the new GNOME policy about preferences.
+I think Havoc Pennington already explained it a lot
better than I could ever do.
http://www106.pair.com/rhp/free-software-ui.html
- User target
-We target non-technical users by design.
+We target non-technical users by design.
This happens to be 90% of the user population.
(Technical details should not exposed in the interface)
We target web users, we dont directly target web developers.
-A few geek-oriented feautures can be kept as
+A few geek-oriented feautures can be kept as
long as they are non-obtrusive.
REQUIREMENTS
-You will need a complete installation of Gnome 2.2 desktop.
-Mozilla API is not stable. I'll be keeping in sync epiphany cvs
-head with mozilla cvs head.
-The required mozilla version will be specified in the
-release notes.
+You will need a complete installation of GNOME 2.x desktop.
+The required WebKit version will be specified in the release notes.
HOW TO HELP
You can report new bugs at
http://bugzilla.gnome.org/enter_bug.cgi?product=epiphany
-Feel free to send patches.
+And feel free to send patches.
About new feautures I'll just quote Metacity FAQ.
@@ -107,7 +98,7 @@ A: If it makes sense to turn on unconditionally,
be embarrassed to put in a simple, uncluttered, user-friendly
configuration dialog.
- If the only rationale for your feature is that other
+ If the only rationale for your feature is that other
[browsers] have it, or that you are personally used to it, or something
like that, then I will not be impressed. [Epiphany] is firmly in the
"choose good defaults" camp rather than the "offer 6 equally broken
diff --git a/TODO b/TODO
index be1b543b3..0103a3d53 100644
--- a/TODO
+++ b/TODO
@@ -6,18 +6,11 @@
Stuff to port to new glib/gtk+ APIs:
- port egg-toolbar-editor to GtkIconView as soon as it supports DND (bug #150270)
-- port to GOption
- port to new gtk+ uri-list DND APIs
- port Downloads directory button in prefs to GtkFileChooserButton
(but wait for bugs #154388, #154390, #154392, #154394)
- port to confirm-overwrite signal of GtkFileChooser
-- use GtkStatusIcon instead of EggStatusIcon
- use g_intern_static_string for static type name registrations
and g_object_set_data
- use gtk_widget_get_action in toolbar code instead of g_object_get_data (., "gtk-action")
- use GtkNotebook DND
-
-Stuff to do when dropping support for mozilla < 1.7:
-- use dependent strings
-- use gtk_moz_embed_set_app_components
-