From 9fdeb1fa5d848bdb65f7f2ee40d0d9b7f318b4ea Mon Sep 17 00:00:00 2001
From: Christoph Groth <christoph.groth@cea.fr>
Date: Tue, 10 Sep 2013 21:26:01 +0200
Subject: [PATCH] mostly intro of install page
---
content/install.txt | 60 ++++++++++++++++++++++-----------------------
1 file changed, 30 insertions(+), 30 deletions(-)
diff --git a/content/install.txt b/content/install.txt
index 80ceaa1..044ab05 100644
--- a/content/install.txt
+++ b/content/install.txt
@@ -1,15 +1,22 @@
-=======
-Install
-=======
-
-Kwant can be installed either using prepared packages (Debian and Ubuntu
-variants of GNU/Linux, Mac OS X, and Windows), or it can be built and installed
-from source.
-
-In general, installation from packages is advisable, especially for novice
-users. Expert users may find it helpful to build Kwant from source, as this
-will also allow them to customize Kwant to use certain optimized versions of
-libraries.
+================================
+Downloading and installing Kwant
+================================
+
+The source code of released versions of Kwant is available for `download
+<http://downloads.kwant-project.org/kwant/>`_. You can follow the development
+by cloning the `Git repository of Kwant <http://git.kwant-project.org/kwant>`_
+(browsable online).
+
+The quickest and easiest way to install Kwant is using the prepared packages
+that are available for GNU/Linux (Debian, Ubuntu, and variants), Windows, and
+Mac OS X. See further below for the instructions for your operating system.
+
+If no packages are available for the system you use, or if you would like to
+install Kwant from source for another reason (expert users may want to customize
+Kwant to use certain optimized versions of libraries), please consult the `full
+installation instructions
+<doc/1.0/pre/install.html#building-and-installing-from-source>`_ in the
+documentation.
Ubuntu (and derivatives)
========================
@@ -99,21 +106,21 @@ provided by Christoph Gohlke. To install Kwant on Windows
Mac OSX
=======
-There is a number of different package managers for bringing software
-from the Unix/Linux world to Mac OSX. Since the community is quite
+There is a number of different package managers to bring software
+from the Unix/Linux world to Mac OS X. Since the community is quite
split, we provide Kwant and its dependencies both via the `MacPorts
<http://www.macports.org>`_ and `homebrew <http://brew.sh>`_ systems.
-(For non experts MacPorts is perhaps easier to handle).
+If you are unsure, go for MacPorts, this is the simpler option.
Mac OSX: MacPorts
=================
MacPorts is a full-fledged package manager that recreates a whole Linux-like
environment on your Mac. Beside Kwant, MacPorts gives you access to a wealth of free softwares which you can install on your computer
-easily (using simple command line instructions). It requires little choices to be made by the user,
-and allows for the simplest way to install Kwant.
+easily (using simple command line instructions). It requires few choices to be made by the user,
+and provides the simplest way to install Kwant.
-In order to install Kwant, you have to
+In order to install Kwant,
1. Install a recent version of MacPorts. In order to do that, you first have to install
the prerequisites described below. When this is done, you can proceed with the installation of
@@ -158,11 +165,11 @@ In order to install Kwant, you have to
Notes:
-* If you have problems with macports because your institution's firewall
- blocks macports (more precisely, the `rsync` port), resulting in
- errors from ``sudo port selfupdate``, follow
- `these instructions <https://trac.macports.org/wiki/howto/PortTreeTarball>`_.
-* Of course, if you already have macports installed, you can skip step 1
+* If you have problems because your institution's firewall blocks MacPorts (more
+ precisely, the `rsync` port), resulting in errors from ``sudo port
+ selfupdate``, follow `these instructions
+ <https://trac.macports.org/wiki/howto/PortTreeTarball>`_.
+* Of course, if you already have MacPorts installed, you can skip step 1
and continue with step 2.
@@ -236,10 +243,3 @@ Notes:
- In principle, you need not install the homebrew python, but could use
Apple's already installed python. Homebrew's python is more up-to-date,
though.
-
-
-Building and installing from source
-===================================
-
-See complete `build instructions
-</docs/pre/install.html#building-and-installing-from-source>`_.
--
GitLab