diff README.rst @ 34579:1b59287a1cfa

doc: rename README to README.rst Many hosting services consider README without extension as plain text. By using .rst extension, we bring better formatting on many services (e.g. bitbucket).
author David Demelier <markand@malikania.fr>
date Tue, 26 Sep 2017 08:37:17 +0200
parents README@76b171209151
children c5912e35d06d
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README.rst	Tue Sep 26 08:37:17 2017 +0200
@@ -0,0 +1,20 @@
+Mercurial
+=========
+
+Mercurial is a fast, easy to use, distributed revision control tool
+for software developers.
+
+Basic install::
+
+ $ make            # see install targets
+ $ make install    # do a system-wide install
+ $ hg debuginstall # sanity-check setup
+ $ hg              # see help
+
+Running without installing::
+
+ $ make local      # build for inplace usage
+ $ ./hg --version  # should show the latest version
+
+See https://mercurial-scm.org/ for detailed installation
+instructions, platform-specific notes, and Mercurial user information.