From 3d97d44b90009e85cbabb7b55a46d84e19821d8a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ren=C3=A9=20Korthaus?= Date: Sat, 30 May 2015 15:24:28 +0200 Subject: [PATCH] Add markdown readme and link INSTALL to README.md --- INSTALL | 45 +-------------------------------------------- README.md | 52 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 53 insertions(+), 44 deletions(-) mode change 100644 => 120000 INSTALL create mode 100644 README.md diff --git a/INSTALL b/INSTALL deleted file mode 100644 index 119761d..0000000 --- a/INSTALL +++ /dev/null @@ -1,44 +0,0 @@ -Basic Installation -================== - -This package is built using Qt's qmake. qmake automatically generates a makefile from the Qt project file. - -1. Requirements -=============== -Since the TPM Manager is based entirely on the Qt UI framework, corresponding header and library files Qt4 should be in the library path. On some linux distributions you have to install the developer version of Qt to have the header files used by TPM Manager. - -Requirements to build the TPM Manager: -• Qt4 (>= 4.4) -• TrouSerS -The required packages for (k)Ubuntu in detail are: -• build-essential -• libtspi-dev -• libtspi1 -• trousers -• libqt4-dev - -To use the features of the TPM Manager you need a running TrouSerS daemon. The TPM Manager has been successfully compiled under Qt version 4.4.3 and KDE 4.1 respectively GNOME 2.26. - -2. Installation and Configuration -================================ -The TPM Manager is hosted on sourceforge at http://sourceforge.net/projects/tpmmanager/. The software is based on qmake; therefore, it can be configured and installed as described below. - -Note that on some systems, qmake points to an older version of Qt - Qt3. Check -your version of Qt prior to compiling TPM Manager as described below. - -# qmake -v -# QMake version 2.01a -# Using Qt version 4.5.2 in /usr/lib - -If qmake points to a 3.X version of Qt, use qmake-qt4 instead of qmake. - -# tar −xzf tpmmanager−0.8.1.tar.gz -# cd tpmmanager−0.8.1 -# qmake -# make -# install bin/tpmmanager /path/to/install/directory // e.g., "install bin/tpmmanager /usr/local/bin" - -3. Usage -======== -Make will create the TPM Manager binary in the bin/ subdirectory. You can run make install to install TPM Manager in default binary path of your system. To start TPM Manager, type tpmmanager on terminal or simply double-click the application icon in your file manager. -You may also add TPM Manager to your Application starter menu, e.g., in Gnome or KDE. diff --git a/INSTALL b/INSTALL new file mode 120000 index 0000000..42061c0 --- /dev/null +++ b/INSTALL @@ -0,0 +1 @@ +README.md \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..1bc7d28 --- /dev/null +++ b/README.md @@ -0,0 +1,52 @@ +# TPM Manager + +The goal of this project is to provide a TPM management software with an easy-to-use graphical user interface. +The TPM Manager will be developed under Linux, but later releases should be usable with all operating systems providing a TSS API. + +![Screenshot](http://i.imgur.com/OwXH1Ye.png) + +## Requirements + +Since the TPM Manager is based entirely on the Qt UI framework, corresponding header and library files Qt4 should be in the library path. +On some linux distributions you have to install the developer version of Qt to have the header files used by TPM Manager. + +Requirements to build the TPM Manager: + +* Qt4 (>= 4.4) (http://qt.io) +* TrouSerS (http://trousers.sourceforge.net/) + +Install the following packages on a Debian-based Linux, e.g., Ubuntu Linux: + +```bash +sudo apt-get install build-essential libtspi-dev libqt4-dev +``` + +To use the features of the TPM Manager you need a running TrouSerS daemon. +The TPM Manager has been successfully compiled under Qt version 4.8.1. + +## Installation and Configuration + +This package is built using Qt's qmake. qmake automatically generates a makefile from the Qt project file. + +```bash +qmake-qt4 +make +``` + +## Usage + +Make will create the TPM Manager application binary in the bin/ subdirectory. +You can start TPM Manager right from the /bin subdirectory or +you can run `install` to install TPM Manager in default binary path of your system. +To start TPM Manager, type tpmmanager on terminal or simply double-click the application icon in your file manager. + +```bash +bin/tpmmanager +``` + +```bash +install bin/tpmmanager /path/to/install/directory // e.g., "install bin/tpmmanager /usr/local/bin" +tpmmanager +``` + +You may also add TPM Manager to your Application starter menu, e.g., in Gnome or KDE.