Skip to content

Commit

Permalink
Fixed the markdown of the README
Browse files Browse the repository at this point in the history
  • Loading branch information
John Lyle committed Jul 6, 2012
1 parent 36d5729 commit 2fccb69
Showing 1 changed file with 21 additions and 24 deletions.
45 changes: 21 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
================================================================================
NODE-TSS
NODE-TSS
================================================================================

NodeJS module for accessing the TCG Software Stack and therefore the Trusted
Expand All @@ -14,56 +14,52 @@ This was originally part of the webinos project (http://webinos.org/) but was
extracted and turned into a separate project.



================================================================================
Requirements
================================================================================
-------------

(1) A TPM or TPM Emulator
(2) A valid TSS stack. I've tested it against the TrouSerS stack.
(3) The cvv8 V8 type conversion headers, as provided in the "includes"
directory. More details - http://code.google.com/p/v8-juice/wiki/V8Convert
1. A TPM or TPM Emulator
2. A valid TSS stack. I've tested it against the TrouSerS stack.
3. The cvv8 V8 type conversion headers, as provided in the "includes"
directory. More details - http://code.google.com/p/v8-juice/wiki/V8Convert



================================================================================
Compilation
================================================================================
-------------

Using node-waf. Two steps:

1) node-waf configure
2) node-waf
<pre>
$ node-waf configure
$ node-waf
</prE>

You will get the following warning:

../src/tsscommands.c: In function ‘getErrorCode’:
../src/tsscommands.c:38:18: warning: cast to pointer from integer of different size



================================================================================
Testing
================================================================================
-------------

There's one test - run the following from the root directory of the module

<pre>
node ./test/test-bridge-main.js
</pre>

It should

================================================================================
TPM Keys
================================================================================
-------------
This API doesn't create keys for you, it needs you to do it.

Go to http://privacyca.com/code.html and follow instructions for the
Privacy CA client and (if possible) the EK Certificate Extractor.


================================================================================

TODO List / known bugs
================================================================================
-------------

At the moment all operations are synchronous. This might need to change.

Expand All @@ -72,10 +68,11 @@ That might be this module, or it might be trousers



================================================================================

License
================================================================================
-------------

<pre>
/*******************************************************************************
* Code originally contributed to the webinos project
*
Expand All @@ -93,4 +90,4 @@ License
*
* Copyright 2011 University of Oxford
*******************************************************************************/

</pre>

0 comments on commit 2fccb69

Please sign in to comment.