aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorThomas White <taw@physics.org>2021-06-21 10:10:38 +0200
committerThomas White <taw@physics.org>2021-06-21 10:10:38 +0200
commit20bfa2400d57ec87506b56d27ac86f5a7872fa43 (patch)
treefa7c7c9e6dbb33dca24213e5fdce5c4da84a5643 /README.md
parent75e2344a59f9b25354e51d754262476ff68b148e (diff)
Move installation documentation to INSTALL.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md70
1 files changed, 2 insertions, 68 deletions
diff --git a/README.md b/README.md
index c86a68ae..fd387fa9 100644
--- a/README.md
+++ b/README.md
@@ -29,78 +29,12 @@ specialised software suite are:
Getting started
---------------
+See INSTALL.md for installation instructions.
+
The best way to get started, after installation, is to run command ```crystfel```
to start the graphical user interface.
-Installation
-------------
-
-CrystFEL installation is supported on GNU/Linux and Mac OS X. The terse
-installation instructions below should be enough if you're experienced with
-installing software from source. More detailed installation information is
-available [on the website](https://www.desy.de/~twhite/crystfel/install.html).
-
-Here are the mandatory dependencies - you cannot install CrystFEL without these:
-
-* Either [CMake](https://cmake.org/) 3.12 or later or [Meson](https://mesonbuild.com/) (Meson is preferred)
-* [HDF5](https://www.hdfgroup.org/downloads/hdf5/) 1.8.0 or later (1.10.0 or later is required for many recent data formats)
-* [GNU Scientific Library (GSL)](https://www.gnu.org/software/gsl/)
-* [Bison](https://www.gnu.org/software/bison/) 2.6 or later
-* [Flex](https://www.gnu.org/software/flex/)
-* [Zlib](https://www.zlib.net/) (1.2.3.5 or later preferred for better decompression speed)
-
-The following dependencies are "optional", in the sense that you can install
-CrystFEL without them. However, a CrystFEL installation without these will lack
-important features such as the graphical user interface:
-
-* GTK3 or later
-* Cairo
-* Pango
-* gdk-pixbuf
-* NCurses
-* libPNG
-* [libccp4](ftp://ftp.ccp4.ac.uk/opensource/)
-
-Note that all of the dependencies mentioned above (including libccp4) should be
-available from your Linux distribution's package manager, or from
-[Homebrew](https://brew.sh/) on Mac OS. You should not need to download and
-install any of them separately from source, and we emphatically recommend
-against trying to do so!
-
-Note that using the libraries from the full CCP4 suite is not recommended. CCP4
-includes so many other libraries that it becomes very difficult to link using
-the correct versions of everything.
-
-Processing data relies on indexing algorithms. The more of the following are
-installed, the better your experience will be:
-
-* [FFTW3](http://fftw.org/)
-* [XGandalf](https://stash.desy.de/users/gevorkov/repos/xgandalf)
-* [PinkIndexer](https://stash.desy.de/users/gevorkov/repos/pinkindexer)
-* [Mosflm](https://www.mrc-lmb.cam.ac.uk/mosflm/mosflm/)
-* [DirAx](http://www.crystal.chem.uu.nl/distr/dirax/)
-* [XDS](http://xds.mpimf-heidelberg.mpg.de/)
-
-Installation follows the normal CMake procedure:
-
-```
-$ mkdir build
-$ cd build
-$ cmake ..
-$ make
-$ sudo make install
-```
-
-Or, with Meson:
-
-```
-$ meson . build
-$ ninja -C build
-$ sudo ninja -C build install
-```
-
-
Licence
-------