From 0f679a589f053adca0951b96bec2d2c5dc5cb505 Mon Sep 17 00:00:00 2001 From: Veselin Georgiev Date: Wed, 4 Nov 2015 01:18:18 +0200 Subject: [PATCH] Update readme, include "users" info as suggested in issue #24. --- README | 36 +++++++++++++++++++++++------------- 1 file changed, 23 insertions(+), 13 deletions(-) diff --git a/README b/README index face3d6..32aac2f 100644 --- a/README +++ b/README @@ -1,26 +1,36 @@ libcpuid ---------- +======== libcpuid provides CPU identification for the x86 (and x86_64). For details about the programming API, please see the docs on the project's site (http://libcpuid.sourceforge.net/) - Configuring after checkout - -------------------------- +Configuring after checkout +-------------------------- - Under linux, where you download the sources, there's no - configure script to run. This is because it isn't a good practice to keep - such scripts in a source control system. To create it, you need to run the - following commands once, after you checkout the libcpuid sources - from github: +Under linux, where you download the sources, there's no +configure script to run. This is because it isn't a good practice to keep +such scripts in a source control system. To create it, you need to run the +following commands once, after you checkout the libcpuid sources +from github: 1. run "libtoolize" 2. run "autoreconf --install" - You need to have autoconf, automake and libtool installed. +You need to have `autoconf`, `automake` and `libtool` installed. - After that you can run "./configure" and "make" - this will build - the library. +After that you can run `./configure` and `make` - this will build +the library. - "make dist" will create a tarball (with "configure" inside) with the - sources. +`make dist` will create a tarball (with "configure" inside) with the +sources. + +Users +----- + +So far, I'm aware of the following projects which utilize libcpuid: + +* CPU-X (https://github.com/X0rg/CPU-X) +* fre:ac (https://www.freac.org/) + +We'd love to hear from you if you are also using libcpuid and want your project listed above.