Improve formatting of readme
This commit is contained in:
Родитель
4492b4781c
Коммит
dfad6dfe92
31
README.md
31
README.md
|
@ -1,5 +1,5 @@
|
||||||
# compoundfilereader
|
# compoundfilereader
|
||||||
simple standalone c++ header file to read compound file (Structured Storage File) content.
|
Simple standalone C++ header file to read compound file (Structured Storage File) content.
|
||||||
|
|
||||||
# Source code structure
|
# Source code structure
|
||||||
- **src/include/compoundfilereader.h**
|
- **src/include/compoundfilereader.h**
|
||||||
|
@ -9,28 +9,28 @@ simple standalone c++ header file to read compound file (Structured Storage File
|
||||||
- **test/data**
|
- **test/data**
|
||||||
Real world compound files for tests.
|
Real world compound files for tests.
|
||||||
- **samples/cfb**
|
- **samples/cfb**
|
||||||
command line tool to list and dump compound files.
|
Command line tool to list and dump compound files.
|
||||||
- **samples/IEOpenedTabParser**
|
- **samples/IEOpenedTabParser**
|
||||||
command line tool to show IE opened tab information.
|
Command line tool to show IE opened tab information.
|
||||||
- **vsproject**
|
- **vsproject**
|
||||||
project and solution files for Microsoft Visual Studio.
|
Project and solution files for Microsoft Visual Studio.
|
||||||
|
|
||||||
# Usage
|
# Usage
|
||||||
- copy compoundfilereader.h to your source tree
|
- Copy compoundfilereader.h to your source tree
|
||||||
or: install "compoundfilereader" by git sub-module
|
or: install "compoundfilereader" by git submodule
|
||||||
- #include <compoundfilereader.h> in your source code
|
- `#include <compoundfilereader.h>` in your source code
|
||||||
- construct a **CompoundFileReader** object by giving the buffer (see compoundfilereader.h for details)
|
- Construct a **CompoundFileReader** object by giving the buffer (see compoundfilereader.h for details)
|
||||||
|
|
||||||
# Build the samples
|
# Build the samples
|
||||||
## Linux
|
## Linux
|
||||||
run `make'
|
Run `make`
|
||||||
(requires gcc and g++)
|
(requires gcc and g++)
|
||||||
## Windows
|
## Windows
|
||||||
option1: double click 'vsproject\cfbreader\cfbreader.sln' then build in Visual Studio
|
- Option 1: double click 'vsproject\cfbreader\cfbreader.sln' then build in Visual Studio
|
||||||
option2: run 'build.bat' in Visual Studio Command Prompt
|
- Option 2: run 'build.bat' in Visual Studio Command Prompt
|
||||||
(requires visual studio)
|
(requires Visual Studio)
|
||||||
## Run the samples
|
## Run the samples
|
||||||
try the following:
|
Try the following:
|
||||||
``` batchfile
|
``` batchfile
|
||||||
out/ieot "test/data/{BC59C035-E8AC-11E4-825B-10604B7CB9F0}.dat"
|
out/ieot "test/data/{BC59C035-E8AC-11E4-825B-10604B7CB9F0}.dat"
|
||||||
out/cfb list "test/data/a test email message.msg"
|
out/cfb list "test/data/a test email message.msg"
|
||||||
|
@ -38,9 +38,8 @@ out/cfb dump "test/data/a test email message.msg" __properties_version1.0
|
||||||
```
|
```
|
||||||
|
|
||||||
# TODO
|
# TODO
|
||||||
- unit tests
|
- Unit tests
|
||||||
- make the reader able to connect to abstract interfaces such as istream
|
- Make the reader able to connect to abstract interfaces such as istream
|
||||||
|
|
||||||
# Microsoft Open Source Code of Conduct
|
# Microsoft Open Source Code of Conduct
|
||||||
|
|
||||||
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
|
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
|
||||||
|
|
Загрузка…
Ссылка в новой задаче