diff options
| author | Philip Tricca <philip.b.tricca@intel.com> | 2017-10-10 15:07:30 -0700 |
|---|---|---|
| committer | Philip Tricca <philip.b.tricca@intel.com> | 2017-10-11 10:18:48 -0700 |
| commit | 1d334083df4b1983d409a8e85127e4384ad89318 (patch) | |
| tree | 90f62c7f20289626eb21537943e6ce763ebd47b0 /README.md | |
| parent | 3dedb668752ff48388d48968ddc2711fa2f57adb (diff) | |
| download | tpm2-tss-1d334083df4b1983d409a8e85127e4384ad89318.tar.gz | |
README.md: Update project / code layout.
The image file used by the last maintainer has no source file so we
can't update it. Migrating this to plain text / markdown will make
future updates much easier. The general structure was generated using
the `tree` command. The descriptions were written manually.
Signed-off-by: Philip Tricca <philip.b.tricca@intel.com>
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 25 |
1 files changed, 21 insertions, 4 deletions
@@ -65,7 +65,24 @@ This approach has a number of advantages including the ability to run individual SAPI library, TAB/RM, and Test Code Block Diagram:  -# [Code Layout](doc/layout.md) -Diagram of the directory structure for the code SAPI library, TAB/RM, and Test -Code. - +# Project Layout +├── common : utility functions used by multiple components +├── doc : various bits of documentation +├── include : header files unstalled in $(includedir) +│ ├── sapi : header files for TPM2 types and core libraries +│ └── tcti : header files for TCTI libraries +├── lib : data files used by the build or installed into $(libdir) +├── log : logging functions +├── m4 : autoconf support macros +├── man : man pages +├── marshal : TPM2 typer 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 +└── test : test code + ├── integration : integration test harness and test cases + ├── tpmclient : monolithic, legacy test application + └── unit : unit tests |