Browse Source

doc: Update README.md

Formatting mostly, but mention --disable-adl-checks.
nfactor-troky
Noel Maersk 11 years ago
parent
commit
e4657791bf
  1. 26
      README.md

26
README.md

@ -39,30 +39,25 @@ Note that **most of the documentation is outdated**. If you want to contribute,
Mandatory: Mandatory:
curl dev library http://curl.haxx.se/libcurl/ * [curl dev library](http://curl.haxx.se/libcurl/) - `libcurl4-openssl-dev` on Debian
(libcurl4-openssl-dev) * [pkg-config](http://www.freedesktop.org/wiki/Software/pkg-config)
* [libtool](http://www.gnu.org/software/libtool/)
pkg-config http://www.freedesktop.org/wiki/Software/pkg-config * [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
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/
Optional: Optional:
curses dev library * curses dev library - `libncurses5-dev` on Debian or `libpdcurses` on WIN32, for text user interface
(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
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: If building from git:
autoconf * autoconf
automake * automake
sgminer-specific configuration options: sgminer-specific configuration options:
--disable-adl Override detection and disable building with adl --disable-adl Override detection and disable building with adl
--disable-adl-checks
--without-curses Do not compile support for curses TUI --without-curses Do not compile support for curses TUI
### *nix build instructions ### *nix build instructions
@ -75,6 +70,9 @@ Then:
CFLAGS="-O2 -Wall -march=native" ./configure <options> CFLAGS="-O2 -Wall -march=native" ./configure <options>
make make
To compile a version that can be used accross machines, remove
`-march=native`.
To compile a debug version, replace `-O2` with `-ggdb`. To compile a debug version, replace `-O2` with `-ggdb`.
Systemwide installation is optional. You may run `sgminer` from the build Systemwide installation is optional. You may run `sgminer` from the build

Loading…
Cancel
Save