Skip to content

Commit

Permalink
Update and rename README.md to README.adoc
Browse files Browse the repository at this point in the history
Fixed README to be the new version and fixed all the broken links.
  • Loading branch information
zsmi authored Nov 12, 2024
1 parent a7edde8 commit c035d8d
Show file tree
Hide file tree
Showing 2 changed files with 90 additions and 64 deletions.
90 changes: 90 additions & 0 deletions README.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
== PP-Module for Web Browser

[cols="1,1,1,1,1,1,1,1"]
|===
8+|webbrowser
| https://github.com/commoncriteria/webbrowser/tree/master[master]
a| https://commoncriteria.github.io/webbrowser/master/webbrowser-release.html[📄]
a|[link=https://github.com/commoncriteria/webbrowser/blob/gh-pages/master/ValidationReport.txt]
image::https://raw.githubusercontent.com/commoncriteria/webbrowser/gh-pages/master/validation.svg[Validation]
a|[link=https://github.com/commoncriteria/webbrowser/blob/gh-pages/master/SanityChecksOutput.md]
image::https://raw.githubusercontent.com/commoncriteria/webbrowser/gh-pages/master/warnings.svg[SanityChecks]
a|[link=https://github.com/commoncriteria/webbrowser/blob/gh-pages/master/SpellCheckReport.txt]
image::https://raw.githubusercontent.com/commoncriteria/webbrowser/gh-pages/master/spell-badge.svg[SpellCheck]
a|[link=https://github.com/commoncriteria/webbrowser/blob/gh-pages/master/TDValidationReport.txt]
image::https://raw.githubusercontent.com/commoncriteria/webbrowser/gh-pages/master/tds.svg[TDs]
a|image::https://raw.githubusercontent.com/commoncriteria/webbrowser/gh-pages/master/transforms.svg[transforms,150]
a|
https://commoncriteria.github.io/webbrowser/master/webbrowser-release-linkable.html[webbrowser-release-linkable.html] +
https://commoncriteria.github.io/webbrowser/master/webbrowser-release.html[webbrowser-release.html] +
https://commoncriteria.github.io/webbrowser/master/webbrowser.html[webbrowser.html] +
|===

https://github.com/commoncriteria/webbrowser/issues[image:https://img.shields.io/github/issues/commoncriteria/webbrowser.svg?maxAge=2592000[GitHub
issues Open]]
image:https://img.shields.io/badge/license-Unlicensed-blue.svg[license]

This repository hosts the draft version of the PP-Module for Web Browser. The repository is used to facilitate collaboration and development on the draft document.
See the [release](#Release-Version) section if you are looking for the officially released version for evaluations.
A list of products that have passed evaluation against this Protection Profile can be found [here](https://www.niap-ccevs.org/Profile/Info.cfm?id=378).

=== Draft Version

* https://commoncriteria.github.io/webbrowser/master/webbrowser-release.html[PP-Module for Web Browsers] (html)

=== Release Version

* https://www.niap-ccevs.org/Profile/Info.cfm?id=378[Extended Package for Web Browsers v2.0]

=== Contributing

If you are interested in contributing directly to future versions the
this Protection Profile, please consider joining the NIAP technical
community. *
https://www.niap-ccevs.org/NIAP_Evolution/tech_communities.cfm[How to
join the NIAP Technical Community (Mailing list and updates)]

=== Feedback

Questions, comments, and fixes can be submitted to the
https://github.com/commoncriteria/webbrowser/issues[repository issue tracker]

=== Quickstart

To clone this project along with its _transforms_ submodule run:

....
git clone --recursive [email protected]:commoncriteria/webbrowser.git
....
To pull updates from the upstream _transforms_ submodule and commit them run:
....
git submodule update --remote transforms
git add transforms
git commit
....

==== Development Info

https://github.com/commoncriteria/transforms/wiki/Working-with-Transforms-as-a-Submodule[Help
working with Transforms Submodule]

=== Repository Content

* input - Contains the `meat' of the project. It’s the input content (in
XML form) that gets transformed to readable html.
* output - The output directory where the html is placed after
transformation.
* output/images - The directory where images are stored
* transforms - Points to the transform subproject which is really a
repository for resources shared amongst many Common Criteria projects.
You shouldn’t need to modify it.

=== Links

* https://www.niap-ccevs.org/[National Information Assurance Partnership
(NIAP)]
* https://www.commoncriteriaportal.org/[Common Criteria Portal]

=== License

See link:./LICENSE[License]
64 changes: 0 additions & 64 deletions README.md

This file was deleted.

0 comments on commit c035d8d

Please sign in to comment.