Skip to content

Commit cbdae4e

Browse files
Tweak README to make it easier to understand
Emphasize the most likely things to do at its beginning, in bold, so most people will quickly see "what to do next". Signed-off-by: David A. Wheeler <[email protected]>
1 parent b454aef commit cbdae4e

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

README.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,23 @@ This repository is for managing and sharing the content of the
55
courses (from the [OpenSSF Best Practices WG](https://github.com/ossf/wg-best-practices-os-developers) that are available via the
66
[Linux Foundation Training &amp; Certification Platform](https://training.linuxfoundation.org/training/developing-secure-software-lfd121/)
77
and via [edX](http://edx.org/professional-certificate/linuxfoundationx-secure-software-development-fundamentals?utm_medium=partner-marketing&utm_source=affiliate&utm_campaign=openssf&utm_content=openssforg-securedevelopmentpc).
8-
If you see something that should be changed, please
9-
[file an issue](https://github.com/ossf/secure-sw-dev-fundamentals/issues).
108

11-
If you just want to *take* these courses, please [select the course you are interested in and take it](https://openssf.org/training/courses/).
9+
## Highlights
1210

13-
See the [*Secure Software Development Fundamentals* content converted into Markdown format](secure_software_development_fundamentals.md) for the main content of this repository.
11+
Please **[select the course you are interested in and take it](https://openssf.org/training/courses/)** if you just want to *take* these courses. This site is intended for those who are updating the courses or using its content in special ways.
12+
13+
Please see **[*Secure Software Development Fundamentals* content converted into Markdown format](secure_software_development_fundamentals.md)** for the main content of this repository.
14+
15+
If you see something in the course that should be changed, please **[file an issue](https://github.com/ossf/secure-sw-dev-fundamentals/issues)** or (even better) **[create a pull request](https://github.com/ossf/secure-sw-dev-fundamentals/pulls)**.
16+
17+
## Details
1418

1519
<img src="by.svg" width="60" height="21" alt="CC-BY">This informational content is released under the [Creative Commons Attribution License (CC-BY) version 4.0](https://creativecommons.org/licenses/by/4.0/legalcode.txt), so you can reuse it in many ways. We want you to use this information! There are some <b>exceptions</b>: we quote some images (such as from xkcd) which are under their own licenses. Also, to counter cheating we do not release certain testing materials this way at all (so they are not in this repository). Note that we update this material, so you should be prepared for updates if you use a significant portion of it.
1620

1721
If you earn a certificate of completion for the course via the Linux Foundation (LF) Training, you can show off the [digital credentials (badges) you've earned](https://training.linuxfoundation.org/badges-2/). Similarly, if you earn a course certificate or program certificate on edX, you can [show your edX certificates](https://www.edx.org/verified-certificate).
1822

19-
If you want to propose changes to the content, the preferred mechanism is
23+
If you want to propose changes to the content, as noted above
24+
the preferred mechanism is
2025
to file [issues](https://github.com/ossf/secure-sw-dev-fundamentals/issues) for general suggestions and provide [pull requests](https://github.com/ossf/secure-sw-dev-fundamentals/pulls) for specific changes, in both cases to this
2126
[secure-sw-dev-fundamentals](https://github.com/ossf/secure-sw-dev-fundamentals)
2227
project. Changes that are accepted into the Markdown must go through a series of internal steps in coordination with LF Training &amp; Certification so that the changes will be deployed to both the LF Training and edX platforms.

0 commit comments

Comments
 (0)