changeset 2095:1c6bb9c117fc

README: rework install instruction

For both evolve and topic. The topic introduction is updated too.

--- a/README	Mon Mar 13 15:09:21 2017 -0700
+++ b/README	Mon Mar 13 15:33:00 2017 -0700
@@ -2,6 +2,9 @@
 Mutable History For Mercurial
 =============================
 
+Evolve Extension
+=================
+
 This package supplies the ``evolve`` extension for Mercurial,
 
 **The full implementation of the changeset evolution concept is still in
@@ -19,40 +22,66 @@
  * provides a ``hg evolve`` command to deal with such "troubles".
    issues.
 
-You can enable it by adding the line below to the ``extensions``
-section of your hgrc::
+Install
+-------
+
+You can install the latest evolution version usin pip::
 
-    evolve = PATH/TO/evolve-main/hgext3rd/evolve/
+    $ pip install --user hg-evolve
+
+Then just enable it in you hgrc::
+
+    $ hg config --edit # adds the two line below:
+    [extensions]
+    evolve =
 
 We recommend reading the documentation first. An online version is
 available here:
 
     https://www.mercurial-scm.org/doc/evolution/
 
-Or see the ``doc/`` directory for a local copy.
+Local Install
+-------------
 
-topic
-=====
+To install a local version from source::
+
+    $ hg clone https://www.mercurial-scm.org/repo/evolve/
+    $ cd evolve
+    $ make install-home
 
-Topics are an experiment to see if maybe the workflow defined by git
-branches and hg bookmarks is only partially what users want - perhaps
-something that feels more like a traditional VCS branch is right, but
-that it should "dissolve" upon being finished. This extension exists
-to be a sandbox for that experimentation.
+Then just enable it in you hgrc::
+
+    $ hg config --edit # adds the two line below:
+    [extensions]
+    evolve =
+
+Documentation lives in ``doc/``.
+
+Topic Extension
+================
 
-# install
+This packages also provides the ``topic`` extensions. It implements a new
+experimental concept to provide lightweight feature branches for the mutable
+parts of the history. The experiments is still at an early stage and have
+significant usability and performance issues.
 
-Enable topics like any mercurial extension: download the source code to a
-local directory, and add that directory to your `.hgrc`:
+enable topic
+------------
 
+The topic extensions is included in the evolve package. See the install instruction for evolve.
+
+Then enable it in you configuration::
+
+    $ hg config --edit # adds the two line below:
     [extensions]
-    topics=PATH/TO/evolve-main/hgext3rd/topic/
-
-# help
+    topics =
 
-See 'hg help -e topic' for a generic help.
-See 'hg help topics' and 'hg help stack' for help on specific commands.
-See the 'tests/test-topic-tutorial.t' file for a quick tutorial.
+help
+----
+
+ * See 'hg help -e topic' for a generic help.
+ * See 'hg help topics' and 'hg help stack' for help on specific commands.
+ * See the 'tests/test-topic-tutorial.t' file for a quick tutorial.
 
 Contribute
 ==========