Skip to content

Commit

Permalink
Minor changes to Readme.rst (#4)
Browse files Browse the repository at this point in the history
# Preface

Please ensure you have read the [contribution
docs](https://github.com/microsoft/mu/blob/master/CONTRIBUTING.md) prior
to submitting the pull request. In particular,
[pull request
guidelines](https://github.com/microsoft/mu/blob/master/CONTRIBUTING.md#pull-request-best-practices).

## Description

<_Please include a description of the change and why this change was
made._>

For each item, place an "x" in between `[` and `]` if true. Example:
`[x]`.
_(you can also check items in the GitHub UI)_

- [ ] Impacts functionality?
- **Functionality** - Does the change ultimately impact how firmware
functions?
- Examples: Add a new library, publish a new PPI, update an algorithm,
...
- [ ] Impacts security?
- **Security** - Does the change have a direct security impact on an
application,
    flow, or firmware?
  - Examples: Crypto algorithm change, buffer overflow fix, parameter
    validation improvement, ...
- [ ] Breaking change?
- **Breaking change** - Will anyone consuming this change experience a
break
    in build or boot behavior?
- Examples: Add a new library class, move a module to a different repo,
call
    a function in a new library class in a pre-existing module, ...
- [ ] Includes tests?
  - **Tests** - Does the change include any explicit test code?
  - Examples: Unit tests, integration tests, robot tests, ...
- [x] Includes documentation?
- **Documentation** - Does the change contain explicit documentation
additions
    outside direct code modifications (and comments)?
- Examples: Update readme file, add feature readme file, link to
documentation
    on an a separate Web page, ...

## How This Was Tested

None

## Integration Instructions

N/A
  • Loading branch information
mikeytdisco authored Feb 22, 2023
1 parent 72b922b commit 17767da
Showing 1 changed file with 57 additions and 21 deletions.
78 changes: 57 additions & 21 deletions Readme.rst
Original file line number Diff line number Diff line change
@@ -1,15 +1,31 @@
==================================
Project Mu Feature Dfci Repository
Project Mu Dfci Feature Repository
==================================

============================= ================= ===================
Host Type & Toolchain Build Status Code Coverage
============================= ================= ===================
Windows_VS2022_ |WindowsCiBuild| |WindowsCiCoverage|
Windows_VS_ |WindowsCiBuild| |WindowsCiCoverage|
Ubuntu_GCC5_ |UbuntuCiBuild| |UbuntuCiCoverage|
============================= ================= ===================

This repository is part of Project Mu. Please see Project Mu for details https://microsoft.github.io/mu
This repository contains the Dfci feature portion of Project Mu. For documentation on Dfci,
see `Device Firmware Configuration Interface <https://microsoft.github.io/mu/dyn/mu_feature_dfci/DfciPkg/Docs/Dfci_Feature/>`_.

Please see `Project Mu <https://microsoft.github.io/mu>`_ for general infomation on Project Mu.


Consuming the Dfci Feature Package
==================================
This project is intended to be included in a platform as a submodule at a particular release tag.


Releases
==============================

Releases of this repository will follow the
`Nuget versioning model <https://docs.microsoft.com/en-us/nuget/concepts/package-versioning>`_.


Branch Status - main
==============================
Expand All @@ -23,7 +39,7 @@ Branch Status - main
:Anticipated Stabilization:
Mar 2023

Branch Changes - release/202208
Branch Changes - main
===============================

Breaking Changes-dev
Expand All @@ -34,35 +50,54 @@ Breaking Changes-dev
Main Changes-dev
----------------

Bug Fixes-dev
-------------
tag "From_mu_plus"

New Repo from mu_plus branch release/202208
--------------------
New Repo from mu_plus branch release/202208 at commit: c69447e15f2b968abd5901c05d0c622650f10f89

ran:

mu_plus at Commit: c69447e15f2b968abd5901c05d0c622650f10f89
git filter-repo --path DfciPkg/ --path ZeroTouchPkg/ --path LICENSE.txt
--path pull_request_template.md --path pip-requirements.txt
--path .gitignore

ran:
tag "From_mu_plus" is the latest commit from mu_plus copied to mu_feature_dfci using the above
git filter-repo command.

git filter-repo --path DfciPkg/ --path ZeroTouchPkg/ --path LICENSE.txt
--path pull_request_template.md --path pip-requirements.txt
--path .gitignore
Bug Fixes-dev
-------------

- None

Code of Conduct
===============

This project has adopted the Microsoft Open Source Code of Conduct https://opensource.microsoft.com/codeofconduct/
This project has adopted the Microsoft Open Source.
See the `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 `[email protected] <mailto:[email protected]>`_ with any additional questions or comments.

Issues
======

For more information see the Code of Conduct FAQ https://opensource.microsoft.com/codeofconduct/faq/
or contact `[email protected] <mailto:opencode@microsoft.com>`_. with any additional questions or comments.
Please open any issues in the Project Mu GitHub tracker.
`More Details <https://microsoft.github.io/mu/How/contributing/>`_

Contributions
=============

Contributions are always welcome and encouraged!
Please open any issues in the Project Mu GitHub tracker and read https://microsoft.github.io/mu/How/contributing/

Please follow the general Project Mu Pull Request process. `More
Details <https://microsoft.github.io/mu/How/contributing/>`_

* `Code Requirements <https://microsoft.github.io/mu/CodeDevelopment/requirements/>`_
* `Doc Requirements <https://microsoft.github.io/mu/DeveloperDocs/requirements/>`_

Builds
======

Please follow the steps in the Project Mu docs to build for CI and local
testing. `More Details <https://microsoft.github.io/mu/CodeDevelopment/compile/>`_

Copyright & License
===================
Expand All @@ -75,16 +110,17 @@ Copyright & License
.. ===================================================================
.. CoreCI
.. |WindowsCiBuild| image:: https://dev.azure.com/projectmu/mu/_apis/build/status/CI/Feature%20DFCI/Mu%20Feature%20DFCI%20-%20CI%20-%20WIndows%20VS?repoName=microsoft%2Fmu_feature_dfci&branchName=main
:target: https://dev.azure.com/projectmu/mu/_build?definitionId=142&_a=summary
:target: https://dev.azure.com/projectmu/mu/_build?definitionId=142&_a=summary

.. _Windows_VS2022: https://dev.azure.com/projectmu/mu/_build/latest?definitionId=142&repoName=microsoft%2Fmu_feature_dfci&branchName=main
.. _Windows_VS: https://dev.azure.com/projectmu/mu/_build/latest?definitionId=142&repoName=microsoft%2Fmu_feature_dfci&branchName=main

.. |WindowsCiCoverage| image:: https://img.shields.io/badge/coverage-coming_soon-blue

.. _Ubuntu_GCC5: https://dev.azure.com/projectmu/mu/_build/latest?definitionId=139&repoName=microsoft%2Fmu_feature_dfci&branchName=main

.. |UbuntuCiBuild| image:: https://dev.azure.com/projectmu/mu/_apis/build/status/CI/Feature%20DFCI/Mu%20Feature%20DFCI%20-%20CI%20-%20GCC5?repoName=microsoft%2Fmu_feature_dfci&branchName=main
:target: https://dev.azure.com/projectmu/mu/_build?definitionId=141&_a=summary
:target: https://dev.azure.com/projectmu/mu/_build?definitionId=141&_a=summary

.. |UbuntuCiCoverage| image:: https://img.shields.io/badge/coverage-coming_soon-blue

0 comments on commit 17767da

Please sign in to comment.