doc update

FabriceSalvaire · FabriceSalvaire · commit c63f7a47113c · 2015-12-27T18:42:32.000+01:00
diff --git a/README.txt b/README.txt
@@ -7,9 +7,9 @@
  CodeReview
 ============
 
-The official CodeReview Home Page is located at |CodeReviewUrl|
+The official CodeReview home page is located at |CodeReviewUrl|
 
-The latest documentation build from the git repository is available at readthedocs.org |CodeReview@readthedocs-badge|
+The latest documentation built from the git repository is available at readthedocs.org |CodeReview@readthedocs-badge|
 
 Written by `Fabrice Salvaire <http://fabrice-salvaire.pagesperso-orange.fr>`_.
 
diff --git a/doc/sphinx/source/features.txt b/doc/sphinx/source/features.txt
@@ -9,4 +9,12 @@ The main features of CodeReview are:
  * display and browse the log and paches of a Git repository
  * diff side by side using Patience algorithm
 
+Diff viewer features:
+ * number of context lines
+ * font size
+ * line number mode
+ * align mode
+ * complete mode
+ * highlight mode
+
 .. end
diff --git a/doc/sphinx/source/introduction.txt b/doc/sphinx/source/introduction.txt
@@ -22,30 +22,7 @@ CodeReview is written in Python 3 and the GUI is based on the Qt5 framework.  Th
 |pygit2|_ provides a Python API to deal with Git repositories.  I tried to achieve a clever design
 and to write a clean code.
 
-Actually CodeReview has a limited number of features.  The followings list gives some ideas to extend its
-features:
-
- * Add Mercurial support. (Git and Mercurial are actually the most cool VCS)
-
- * Add a graphical representation of the branches.  I don't understand the crappy code of qlog and I
-   don't know any algorithm on this topic (graphviz, qgit ?).  To summarize I don't what and how to do.
-
- * Implement the detection of code translocations.  Sometimes we move code within a file or a
-   project.  Such changes are related as deletion and addition in the code, which don't help to
-   review code.  We can do something clever by computing a distance between all the added and
-   deleted chuncks.  The distance could be computed using a Levenshtein, Damerau–Levenshtein,
-   Needleman–Wunsch or Smith–Waterman algorithm (DNA alignment algorithms).
-
- * Implement code analyser/validator as language plugins.  The idea is to annotate change as
-   cosmetic or dangerous modifications.  For example a deleted or added space is a cosmetic change
-   in C, but it can be a regression in Python where the indentation is part of the grammar.
-
- * Implement blame wich is another important feature.
-
- * Implement comments and maybe as a client-server architecture.
-
- * look https://docs.python.org/3.4/library/difflib.html
-
 .. include:: features.txt
+.. include:: new-features.txt
 
 .. End
diff --git a/doc/sphinx/source/new-features.txt b/doc/sphinx/source/new-features.txt
@@ -0,0 +1,31 @@
+.. -*- Mode: rst -*-
+
+===============================
+ Ideas for Additional Features
+===============================
+
+Actually CodeReview has a limited number of features.  The followings list gives some ideas to extend its
+features:
+
+ * Add Mercurial support. (Git and Mercurial are actually the most cool VCS)
+
+ * Add a graphical representation of the branches.  I don't understand the crappy code of qlog and I
+   don't know any algorithm on this topic (graphviz, qgit ?).  To summarize I don't what and how to do.
+
+ * Implement the detection of code translocations.  Sometimes we move code within a file or a
+   project.  Such changes are related as deletion and addition in the code, which don't help to
+   review code.  We can do something clever by computing a distance between all the added and
+   deleted chuncks.  The distance could be computed using a Levenshtein, Damerau–Levenshtein,
+   Needleman–Wunsch or Smith–Waterman algorithm (DNA alignment algorithms).
+
+ * Implement code analyser/validator as language plugins.  The idea is to annotate change as
+   cosmetic or dangerous modifications.  For example a deleted or added space is a cosmetic change
+   in C, but it can be a regression in Python where the indentation is part of the grammar.
+
+ * Implement blame wich is another important feature.
+
+ * Implement comments and maybe as a client-server architecture.
+
+ * look https://docs.python.org/3.4/library/difflib.html
+
+.. end
