From 146b5181774fbe6dede4851ad824b41c6cdd3b07 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Sun, 14 Jan 2018 21:39:59 +0100 Subject: [PATCH] Emphasize the availability of packages even more. --- README.md | 72 ++++-------------------------------------------- doc/mainpage.dox | 2 +- 2 files changed, 6 insertions(+), 68 deletions(-) diff --git a/README.md b/README.md index 819486afa..bf3bb7c9f 100644 --- a/README.md +++ b/README.md @@ -71,78 +71,16 @@ Graphics APIs: See the [Build Status page](http://magnum.graphics/build-status/) for detailed per-platform build status. -BUILDING MAGNUM -=============== - -You can either use packaging scripts, which are stored in the -[package/](https://github.com/mosra/magnum/tree/master/package) subdirectory, -or compile and install everything manually. A short guide is below, for better -introduction it's advised to read through the -[Getting Started Guide](http://doc.magnum.graphics/magnum/getting-started.html) -in the documentation. Complete building documentation covering all platforms -and feature sets is in the [Downloading and building](http://doc.magnum.graphics/magnum/building.html) -page. - -Minimal dependencies --------------------- - -- C++ compiler with good C++11 support. Compilers which are tested to have - everything needed are **GCC** >= 4.7, **Clang** >= 3.1 and **MSVC** >= 2015. - On Windows you can also use **MinGW-w64**. -- **CMake** >= 2.8.12 -- **Corrade** — Plugin management and utility library. You can get it at - https://github.com/mosra/corrade. - -Compilation, installation -------------------------- - -The library (for example with support for SDL2 applications) can be built and -installed using these commands: - -```sh -git clone git://github.com/mosra/magnum && cd magnum -mkdir -p build && cd build -cmake .. \ - -DCMAKE_INSTALL_PREFIX=/usr \ - -DWITH_SDL2APPLICATION=ON -make -j -make install # sudo may be required -``` - -Building and running unit tests -------------------------------- - -If you want to build also unit tests (which are not built by default), pass -`-DBUILD_TESTS=ON` to CMake. Unit tests use Corrade's TestSuite framework and -can be run using - -```sh -ctest --output-on-failure -``` - -in build directory. Everything should pass ;) - -Building documentation ----------------------- - -The documentation is written using [Doxygen](https://doxygen.org). It can be -build by running - -```sh -doxygen -``` - -in the root directory (i.e. where `Doxyfile` is). You might need to create the -`build/` directory if it doesn't exist yet. Resulting HTML documentation will -be in the `build/doc/` directory. Snapshot of the documentation is -[also available for online viewing](http://doc.magnum.graphics/). - GETTING STARTED =============== The best way to get started is to read the thorough [download, build, install and start using Magnum](http://doc.magnum.graphics/magnum/getting-started.html) -in your project. After that, there are various [tutorials and examples](http://doc.magnum.graphics/magnum/example-index.html) +in your project. There is also a complete +[building documentation](http://doc.magnum.graphics/magnum/building.html) — we +provide packages for many platforms, including Windows, Linux and macOS. + +After that, there are various [tutorials and examples](http://doc.magnum.graphics/magnum/example-index.html) and a complete [feature guide](http://doc.magnum.graphics/magnum/features.html) explaining all aspects of the library. diff --git a/doc/mainpage.dox b/doc/mainpage.dox index 1288492b6..9b5d17361 100644 --- a/doc/mainpage.dox +++ b/doc/mainpage.dox @@ -37,7 +37,7 @@ overview, project goals or read the developer blog, head over to the The best way to get started is to read the thorough @ref getting-started "guide to download, build, install and start using Magnum" in your project. There is also a complete @ref building documentation --- we -provide ready-made packages for many platforms. +provide packages for many platforms, including Windows, Linux and macOS. After that, there are various @ref example-index "tutorials and examples" and a complete @ref features "feature guide" explaining all aspects of the