From e4657791bf1c415d9399b81bc9b3ae88d336ca2a Mon Sep 17 00:00:00 2001 From: Noel Maersk Date: Thu, 6 Feb 2014 18:50:38 +0200 Subject: [PATCH] doc: Update README.md Formatting mostly, but mention --disable-adl-checks. --- README.md | 26 ++++++++++++-------------- 1 file changed, 12 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index d1426dd1..7ca75c46 100644 --- a/README.md +++ b/README.md @@ -39,30 +39,25 @@ Note that **most of the documentation is outdated**. If you want to contribute, Mandatory: - curl dev library http://curl.haxx.se/libcurl/ - (libcurl4-openssl-dev) - - pkg-config http://www.freedesktop.org/wiki/Software/pkg-config - libtool hhttp://www.gnu.org/software/libtool/ - - AMD APP SDK http://developer.amd.com/tools-and-sdks/heterogeneous-computing/amd-accelerated-parallel-processing-app-sdk/downloads/ +* [curl dev library](http://curl.haxx.se/libcurl/) - `libcurl4-openssl-dev` on Debian +* [pkg-config](http://www.freedesktop.org/wiki/Software/pkg-config) +* [libtool](http://www.gnu.org/software/libtool/) +* [AMD APP SDK](http://developer.amd.com/tools-and-sdks/heterogeneous-computing/amd-accelerated-parallel-processing-app-sdk/downloads/) - available under various names as a package on different GNU/Linux distributions Optional: - curses dev library - (libncurses5-dev or libpdcurses on WIN32 for text user interface) - - AMD ADL SDK http://developer.amd.com/tools-and-sdks/graphics-development/display-library-adl-sdk/ - (Version 5 or 6, required for ATI GPU monitoring & clocking) +* curses dev library - `libncurses5-dev` on Debian or `libpdcurses` on WIN32, for text user interface +* [AMD ADL SDK](http://developer.amd.com/tools-and-sdks/graphics-development/display-library-adl-sdk/) - version 5 or 6, required for ATI GPU monitoring & clocking If building from git: - autoconf - automake +* autoconf +* automake sgminer-specific configuration options: --disable-adl Override detection and disable building with adl + --disable-adl-checks --without-curses Do not compile support for curses TUI ### *nix build instructions @@ -75,6 +70,9 @@ Then: CFLAGS="-O2 -Wall -march=native" ./configure make +To compile a version that can be used accross machines, remove +`-march=native`. + To compile a debug version, replace `-O2` with `-ggdb`. Systemwide installation is optional. You may run `sgminer` from the build