Skip to content

Commit

Permalink
Convert README to markdown.
Browse files Browse the repository at this point in the history
The old file is only kept as required by autotools.
  • Loading branch information
anrieff committed Nov 3, 2015
1 parent 0f679a5 commit 8b64940
Show file tree
Hide file tree
Showing 3 changed files with 38 additions and 37 deletions.
2 changes: 1 addition & 1 deletion Makefile.am
Expand Up @@ -4,7 +4,7 @@ SUBDIRS = libcpuid cpuid_tool tests
pkgconfigdir = $(libdir)/pkgconfig

pkgconfig_DATA = libcpuid.pc
EXTRA_DIST = libcpuid.pc.in libcpuid_vc71.sln libcpuid_vc9.sln
EXTRA_DIST = libcpuid.pc.in libcpuid_vc71.sln libcpuid_vc9.sln Readme.md

consistency:
$(top_srcdir)/libcpuid/check-consistency.py $(top_srcdir)/libcpuid
Expand Down
37 changes: 1 addition & 36 deletions README
@@ -1,36 +1 @@
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
--------------------------

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.

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.

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.
See Readme.md
36 changes: 36 additions & 0 deletions Readme.md
@@ -0,0 +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
--------------------------

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.

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.

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 8b64940

Please sign in to comment.