Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move from md to html for API docs to be hosted on github pages. #545 #562

Merged
merged 3 commits into from
Aug 21, 2018
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
7 changes: 4 additions & 3 deletions .check-license.ignore
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,16 @@
./.clang-format
./debugger/pythonExtension/load_symbol_cmd.py
./debugger/pythonExtension/readelf.py
./doc/DesignOverview.docx
./doc/DesignOverview.pdf
./docs/DesignOverview.docx
./docs/DesignOverview.pdf
./docs/refman/html
.exrc
./.git
.gitignore
./include/openenclave/internal/queue.h
LICENSE
*.md
*.html
*.json
./.openenclaveroot
*.pem
Expand Down Expand Up @@ -61,7 +63,6 @@ LICENSE
./tools/oesign/files/log.txt
VERSION
./prereqs/packages/.packages
./doc/refman/md/*.dump
./3rdparty/LICENSES
./tests/report/data/tcbInfo.json
./tests/report/data/quote.dat
Expand Down
2 changes: 1 addition & 1 deletion CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ add_subdirectory(tests)
if (UNIX)
add_subdirectory(3rdparty)
add_subdirectory(debugger)
add_subdirectory(doc/refman)
add_subdirectory(docs/refman)
add_subdirectory(enclave)
add_subdirectory(enclave/core)
add_subdirectory(idl)
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,22 +20,22 @@ The current implementation of Open Enclave is built on [Intel Software Guard Ext
Design Overview
-------------

The [Design Overview](doc/DesignOverview.pdf) document provides a brief design overview of the Open Enclave SDK. It describes the parts of the SDK and how they work together to create, invoke, and terminate enclaves.
The [Design Overview](docs/DesignOverview.pdf) document provides a brief design overview of the Open Enclave SDK. It describes the parts of the SDK and how they work together to create, invoke, and terminate enclaves.

Getting Started
---------------
To build and experience enclaves with the Open Enclave SDK, start [here](doc/GettingStartedDocs/GettingStarted.md)
To build and experience enclaves with the Open Enclave SDK, start [here](docs/GettingStartedDocs/GettingStarted.md)

Contributing
------------

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, see [Contributing to Open Enclave](doc/Contributing.md).
This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, see [Contributing to Open Enclave](docs/Contributing.md).

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.

See the [Development Guide](doc/DevelopmentGuide.md) for details about developing code in this repo, such as coding style and development processes.
See the [Development Guide](docs/DevelopmentGuide.md) for details about developing code in this repo, such as coding style and development processes.


Licensing
Expand Down

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.