aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAndreas Fuchs <andreas.fuchs@sit.fraunhofer.de>2018-03-27 15:15:14 +0200
committerTadeusz Struk <tadeusz.struk@intel.com>2018-03-28 16:12:08 -0700
commitf7d0b570983205d068c706b0a0e5fec744a554a6 (patch)
tree2cbbd854be80296f8ef9fadfb49420351007ec7d /README.md
parent5eac105c8385bedcd5089c20297496488c83792c (diff)
downloadtpm2-tss-f7d0b570983205d068c706b0a0e5fec744a554a6.tar.gz
doc: Update Readme src structure
Update README.md to reflect latest updates to the source code structure and layout. Signed-off-by: Andreas Fuchs <andreas.fuchs@sit.fraunhofer.de>
Diffstat (limited to 'README.md')
-rw-r--r--README.md25
1 files changed, 10 insertions, 15 deletions
diff --git a/README.md b/README.md
index 2db26497..b77faaa1 100644
--- a/README.md
+++ b/README.md
@@ -78,26 +78,21 @@ SAPI library, TAB/RM, and Test Code Block Diagram:
![Architecture Block Diagram](doc/TSS%20block%20diagram.png)
# Project Layout
-├── common : utility functions used by multiple components
├── doc : various bits of documentation
-├── esapi : system API implementation
-│   ├── esapi : enhanced system API implementation
-│   └── esapi_util : utility functions used by ESAPI implementation
-├── include : header files unstalled in $(includedir)
-│   ├── esapi : header file for ESAPI library
-│   ├── sapi : header files for TPM2 types and core libraries
-│   └── tcti : header files for TCTI libraries
+├── include : header files installed in $(includedir)
+│ └── tss2 : all public headers for this project
├── lib : data files used by the build or installed into $(libdir)
-├── log : logging functions
├── m4 : autoconf support macros
├── man : man pages
-├── marshal : TPM2 type marshalling library implementation
├── script : scripts used by the build or CI
-├── sysapi : system API implementation
-│   ├── include : headers internal to the SAPI
-│   ├── sysapi : system API implementation
-│   └── sysapi_util : utility functions used by system API implementation
-├── tcti : TCTI implementation
+├── src : all source files
+│ ├── tss2-esys : enhanced system API (ESAPI) implementation
+│ │   └── api : ESAPI TPM API implementation
+│ ├── tss2-mu : TPM2 type marshaling/unmarshaling (MU) API implementation
+│ ├── tss2-sys : system API (SAPI) implementation
+│ │   └── api : SAPI public API implementation
+│ ├── tss2-tcti : TCTI implementations for device and mssim
+│ └── util : Internal utility library (e.g. logging framework)
└── test : test code
   ├── integration : integration test harness and test cases
   ├── tpmclient : monolithic, legacy test application