From 8b64940a0a23ec9c4ba2ec958b6d481afdc01e9b Mon Sep 17 00:00:00 2001 From: Veselin Georgiev Date: Wed, 4 Nov 2015 01:28:44 +0200 Subject: [PATCH] Convert README to markdown. The old file is only kept as required by autotools. --- Makefile.am | 2 +- README | 37 +------------------------------------ Readme.md | 36 ++++++++++++++++++++++++++++++++++++ 3 files changed, 38 insertions(+), 37 deletions(-) create mode 100644 Readme.md diff --git a/Makefile.am b/Makefile.am index 3ad7d4d..2ebbbe0 100644 --- a/Makefile.am +++ b/Makefile.am @@ -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 diff --git a/README b/README index 32aac2f..24619ab 100644 --- a/README +++ b/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 diff --git a/Readme.md b/Readme.md new file mode 100644 index 0000000..32aac2f --- /dev/null +++ b/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.