Skip to content

Commit aeb1ecc

Browse files
author
Jiaxin Wu
committed
Add template of edk2-TemplateSpecification
Signed-off-by: Jiaxin Wu <[email protected]>
0 parents  commit aeb1ecc

27 files changed

+1375
-0
lines changed

‎.bookignore‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
/.github
2+
.gitignore
3+
.bookignore

‎.github/workflows/gitbook-action.yml‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
name: 'Gitbook Action Build'
2+
on:
3+
push:
4+
branches:
5+
- master
6+
- release/*
7+
workflow_dispatch:
8+
9+
jobs:
10+
build:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- name: Checkout action
14+
uses: actions/checkout@v2
15+
- name: Get Branch
16+
run: |
17+
branch=${{ github.ref_name }}
18+
pubdir=${branch/master/draft}
19+
pubdir=${pubdir////-}
20+
echo "ON_PUSH_BRANCH_NAME=$branch" >> $GITHUB_ENV
21+
echo "ON_PUSH_PUBDIR=$pubdir" >> $GITHUB_ENV
22+
- name: Gitbook Action
23+
uses: zanderzhao/[email protected]
24+
with:
25+
token: ${{secrets.GITBOOK_ACTION_PERSONAL_TOKEN}}
26+
source_branch: ${{env.ON_PUSH_BRANCH_NAME}}
27+
publish_branch: gh-pages
28+
publish_dir: ${{env.ON_PUSH_PUBDIR}}
29+
publish_remove_last_build: true
30+
gitbook_pdf: true
31+
gitbook_pdf_dir: /
32+
gitbook_pdf_name: ${{ github.event.repository.name }}-${{env.ON_PUSH_PUBDIR}}
33+
gitbook_epub: true
34+
gitbook_epub_dir: /
35+
gitbook_epub_name: ${{ github.event.repository.name }}-${{env.ON_PUSH_PUBDIR}}
36+
gitbook_mobi: true
37+
gitbook_mobi_dir: /
38+
gitbook_mobi_name: ${{ github.event.repository.name }}-${{env.ON_PUSH_PUBDIR}}

‎.gitignore‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Node rules:
2+
## Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
3+
.grunt
4+
5+
## Dependency directory
6+
## Commenting this out is preferred by some people, see
7+
## https://docs.npmjs.com/misc/faq#should-i-check-my-node_modules-folder-into-git
8+
/node_modules
9+
10+
# Book build output
11+
/_book
12+
13+
# eBook build output
14+
/book.epub
15+
/book.mobi
16+
/book.pdf

‎CONTRIBUTIONS.txt‎

Lines changed: 175 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,175 @@
1+
======================
2+
= Code Contributions =
3+
======================
4+
5+
To make a contribution to a TianoCore project, follow these steps.
6+
1. Create a change description in the format specified below to
7+
use in the source control commit log.
8+
2. Your commit message must include your "Signed-off-by" signature,
9+
and "Contributed-under" message.
10+
3. Your "Contributed-under" message explicitly states that the
11+
contribution is made under the terms of the specified
12+
contribution agreement. Your "Contributed-under" message
13+
must include the name of contribution agreement and version.
14+
For example: Contributed-under: TianoCore Contribution Agreement 1.0
15+
The "TianoCore Contribution Agreement" is included below in
16+
this document.
17+
4. Submit your code to the TianoCore project using the process
18+
that the project documents on its web page. If the process is
19+
not documented, then submit the code on development email list
20+
for the project.
21+
5. It is preferred that contributions are submitted using the same
22+
copyright license as the base project. When that is not possible,
23+
then contributions using the following licenses can be accepted:
24+
* BSD (2-clause): http://opensource.org/licenses/BSD-2-Clause
25+
* BSD (3-clause): http://opensource.org/licenses/BSD-3-Clause
26+
* MIT: http://opensource.org/licenses/MIT
27+
* Python-2.0: http://opensource.org/licenses/Python-2.0
28+
* Zlib: http://opensource.org/licenses/Zlib
29+
For documentation: https://www.freebsd.org/copyright/freebsd-doc-license.html
30+
31+
Contributions of code put into the public domain can also be
32+
accepted.
33+
34+
Contributions using other licenses might be accepted, but further
35+
review will be required.
36+
37+
========================================
38+
= TianoCore Contribution Agreement 1.1 =
39+
========================================
40+
41+
INTEL CORPORATION ("INTEL") MAKES AVAILABLE SOFTWARE, DOCUMENTATION ("DOCUMENTATION"),
42+
INFORMATION AND/OR OTHER MATERIALS FOR USE IN THE TIANOCORE OPEN SOURCE
43+
PROJECT (COLLECTIVELY "CONTENT"). USE OF THE CONTENT IS GOVERNED BY THE
44+
TERMS AND CONDITIONS OF THIS AGREEMENT BETWEEN YOU AND INTEL AND/OR THE
45+
TERMS AND CONDITIONS OF LICENSE AGREEMENTS OR NOTICES INDICATED OR
46+
REFERENCED BELOW. BY USING THE CONTENT, YOU AGREE THAT YOUR USE OF THE
47+
CONTENT IS GOVERNED BY THIS AGREEMENT AND/OR THE TERMS AND CONDITIONS
48+
OF ANY APPLICABLE LICENSE AGREEMENTS OR NOTICES INDICATED OR REFERENCED
49+
BELOW. IF YOU DO NOT AGREE TO THE TERMS AND CONDITIONS OF THIS
50+
AGREEMENT AND THE TERMS AND CONDITIONS OF ANY APPLICABLE LICENSE
51+
AGREEMENTS OR NOTICES INDICATED OR REFERENCED BELOW, THEN YOU MAY NOT
52+
USE THE CONTENT.
53+
54+
Unless otherwise indicated, all Content (except Documentation) made available on the TianoCore
55+
site is provided to you under the terms and conditions of the BSD
56+
License ("BSD"). A copy of the BSD License is available at
57+
http://opensource.org/licenses/bsd-license.php
58+
or when applicable, in the associated License.txt file.
59+
60+
Unless otherwise indicated, all Documentation made available on the
61+
TianoCore site is provided to you under the terms and conditions of the
62+
FreeBSD Documentation License ("FreeBSD"). A copy of the BSD License is
63+
available at https://www.freebsd.org/copyright/freebsd-doc-license.html or,
64+
when applicable, in the associated License.txt file.
65+
66+
Certain other content may be made available under other licenses as
67+
indicated in or with such Content(for example, in a License.txt file).
68+
69+
You accept and agree to the following terms and conditions for Your
70+
present and future Contributions submitted to TianoCore site. Except
71+
for the license granted to Intel hereunder, You reserve all right,
72+
title, and interest in and to Your Contributions.
73+
74+
== SECTION 1: Definitions ==
75+
* "You" or "Contributor" shall mean the copyright owner or legal
76+
entity authorized by the copyright owner that is making a
77+
Contribution hereunder. All other entities that control, are
78+
controlled by, or are under common control with that entity are
79+
considered to be a single Contributor. For the purposes of this
80+
definition, "control" means (i) the power, direct or indirect, to
81+
cause the direction or management of such entity, whether by
82+
contract or otherwise, or (ii) ownership of fifty percent (50%)
83+
or more of the outstanding shares, or (iii) beneficial ownership
84+
of such entity.
85+
* "Contribution" shall mean any original work of authorship,
86+
including any modifications or additions to an existing work,
87+
that is intentionally submitted by You to the TinaoCore site for
88+
inclusion in, or documentation of, any of the Content. For the
89+
purposes of this definition, "submitted" means any form of
90+
electronic, verbal, or written communication sent to the
91+
TianoCore site or its representatives, including but not limited
92+
to communication on electronic mailing lists, source code
93+
control systems, and issue tracking systems that are managed by,
94+
or on behalf of, the TianoCore site for the purpose of
95+
discussing and improving the Content, but excluding
96+
communication that is conspicuously marked or otherwise
97+
designated in writing by You as "Not a Contribution."
98+
99+
== SECTION 2: License for Contributions ==
100+
* Contributor hereby agrees that redistribution and use of the
101+
Contribution in source and binary forms, with or without
102+
modification, are permitted provided that the following
103+
conditions are met:
104+
** Redistributions of source code must retain the Contributor's
105+
copyright notice, this list of conditions and the following
106+
disclaimer.
107+
** Redistributions in binary form must reproduce the Contributor's
108+
copyright notice, this list of conditions and the following
109+
disclaimer in the documentation and/or other materials provided
110+
with the distribution.
111+
* Disclaimer. None of the names of Contributor, Intel, or the names
112+
of their respective contributors may be used to endorse or
113+
promote products derived from this software without specific
114+
prior written permission.
115+
* Contributor grants a license (with the right to sublicense) under
116+
claims of Contributor's patents that Contributor can license that
117+
are infringed by the Contribution (as delivered by Contributor) to
118+
make, use, distribute, sell, offer for sale, and import the
119+
Contribution and derivative works thereof solely to the minimum
120+
extent necessary for licensee to exercise the granted copyright
121+
license; this patent license applies solely to those portions of
122+
the Contribution that are unmodified. No hardware per se is
123+
licensed.
124+
* EXCEPT AS EXPRESSLY SET FORTH IN SECTION 3 BELOW, THE
125+
CONTRIBUTION IS PROVIDED BY THE CONTRIBUTOR "AS IS" AND ANY
126+
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
127+
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
128+
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
129+
CONTRIBUTOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
130+
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
131+
NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
132+
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
133+
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
134+
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
135+
OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THE
136+
CONTRIBUTION, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
137+
DAMAGE.
138+
139+
== SECTION 3: Representations ==
140+
* You represent that You are legally entitled to grant the above
141+
license. If your employer(s) has rights to intellectual property
142+
that You create that includes Your Contributions, You represent
143+
that You have received permission to make Contributions on behalf
144+
of that employer, that Your employer has waived such rights for
145+
Your Contributions.
146+
* You represent that each of Your Contributions is Your original
147+
creation (see Section 4 for submissions on behalf of others).
148+
You represent that Your Contribution submissions include complete
149+
details of any third-party license or other restriction
150+
(including, but not limited to, related patents and trademarks)
151+
of which You are personally aware and which are associated with
152+
any part of Your Contributions.
153+
154+
== SECTION 4: Third Party Contributions ==
155+
* Should You wish to submit work that is not Your original creation,
156+
You may submit it to TianoCore site separately from any
157+
Contribution, identifying the complete details of its source
158+
and of any license or other restriction (including, but not
159+
limited to, related patents, trademarks, and license agreements)
160+
of which You are personally aware, and conspicuously marking the
161+
work as "Submitted on behalf of a third-party: [named here]".
162+
163+
== SECTION 5: Miscellaneous ==
164+
* Applicable Laws. Any claims arising under or relating to this
165+
Agreement shall be governed by the internal substantive laws of
166+
the State of Delaware or federal courts located in Delaware,
167+
without regard to principles of conflict of laws.
168+
* Language. This Agreement is in the English language only, which
169+
language shall be controlling in all respects, and all versions
170+
of this Agreement in any other language shall be for accommodation
171+
only and shall not be binding. All communications and notices made
172+
or given pursuant to this Agreement, and all documentation and
173+
support to be provided, unless otherwise noted, shall be in the
174+
English language.
175+

‎LICENSE.txt‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
Redistribution and use in source (original document form) and 'compiled'
2+
forms (converted to PDF, epub, HTML and other formats) with or without
3+
modification, are permitted provided that the following conditions are met:
4+
5+
1. Redistributions of source code (original document form) must retain the
6+
above copyright notice, this list of conditions and the following
7+
disclaimer as the first lines of this file unmodified.
8+
9+
2. Redistributions in compiled form (transformed to other DTDs, converted to
10+
PDF, epub, HTML and other formats) must reproduce the above copyright
11+
notice, this list of conditions and the following disclaimer in the
12+
documentation and/or other materials provided with the distribution.
13+
14+
THIS DOCUMENTATION IS PROVIDED BY TIANOCORE PROJECT "AS IS" AND ANY EXPRESS OR
15+
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
16+
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
17+
EVENT SHALL TIANOCORE PROJECT BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
18+
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19+
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
20+
OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
21+
WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
22+
OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS DOCUMENTATION, EVEN IF
23+
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

‎README.md‎

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
<!--- @file
2+
README.md for EDK II Template Specification
3+
4+
Copyright (c) 2017, Intel Corporation. All rights reserved.<BR>
5+
6+
Redistribution and use in source (original document form) and 'compiled'
7+
forms (converted to PDF, epub, HTML and other formats) with or without
8+
modification, are permitted provided that the following conditions are met:
9+
10+
1) Redistributions of source code (original document form) must retain the
11+
above copyright notice, this list of conditions and the following
12+
disclaimer as the first lines of this file unmodified.
13+
14+
2) Redistributions in compiled form (transformed to other DTDs, converted to
15+
PDF, epub, HTML and other formats) must reproduce the above copyright
16+
notice, this list of conditions and the following disclaimer in the
17+
documentation and/or other materials provided with the distribution.
18+
19+
THIS DOCUMENTATION IS PROVIDED BY TIANOCORE PROJECT "AS IS" AND ANY EXPRESS OR
20+
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
21+
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
22+
EVENT SHALL TIANOCORE PROJECT BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23+
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
24+
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
25+
OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
26+
WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
27+
OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS DOCUMENTATION, EVEN IF
28+
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29+
30+
-->
31+
32+
<img src="media/TianocoreTitlePageLogo.jpg" width="300" />
33+
34+
### {{ book.title }}
35+
36+
{% if book.draft %}
37+
** DRAFT FOR REVIEW **
38+
{% else %}
39+
** {{ book.version }} **
40+
{% endif %}
41+
42+
** {{ gitbook.time|date('MM/DD/YYYY hh:mm:ss') }} **
43+
44+
{% if book.udkrelease %}
45+
** {{ book.udkrelease }} **
46+
{% endif %}
47+
48+
49+
### Acknowledgements
50+
51+
Redistribution and use in source (original document form) and 'compiled'
52+
forms (converted to PDF, epub, HTML and other formats) with or without
53+
modification, are permitted provided that the following conditions are met:
54+
55+
1. Redistributions of source code (original document form) must retain the
56+
above copyright notice, this list of conditions and the following
57+
disclaimer as the first lines of this file unmodified.
58+
59+
2. Redistributions in compiled form (transformed to other DTDs, converted to
60+
PDF, epub, HTML and other formats) must reproduce the above copyright
61+
notice, this list of conditions and the following disclaimer in the
62+
documentation and/or other materials provided with the distribution.
63+
64+
THIS DOCUMENTATION IS PROVIDED BY TIANOCORE PROJECT "AS IS" AND ANY EXPRESS OR
65+
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
66+
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
67+
EVENT SHALL TIANOCORE PROJECT BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
68+
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
69+
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
70+
OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
71+
WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
72+
OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS DOCUMENTATION, EVEN IF
73+
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
74+
75+
Copyright (c) 2017, Intel Corporation. All rights reserved.
76+
77+
### Revision History
78+
79+
| Revision | Revision History | Date |
80+
| ---------- | ------------------ | ----------- |
81+
| 0.10 | Initial release. | March 2017 |
82+
| 0.20 | Second release. | March 2017 |

0 commit comments

Comments
 (0)