Skip to content

Commit

Permalink
Update readme, include "users" info as suggested in issue #24.
Browse files Browse the repository at this point in the history
  • Loading branch information
anrieff committed Nov 3, 2015
1 parent 8c7b2fe commit 0f679a5
Showing 1 changed file with 23 additions and 13 deletions.
36 changes: 23 additions & 13 deletions README
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit 0f679a5

Please sign in to comment.