summaryrefslogtreecommitdiff
path: root/README.md
Commit message (Collapse)AuthorAgeFilesLines
* README: add missing link to OpenSSL 3.0 manual pagesDr. Matthias St. Pierre2022-03-111-0/+1
| | | | | | | Reviewed-by: Tomas Mraz <tomas@openssl.org> Reviewed-by: Richard Levitte <levitte@openssl.org> Reviewed-by: Paul Dale <pauli@openssl.org> (Merged from https://github.com/openssl/openssl/pull/17855)
* README: add link to migration_guide manual pageDr. Matthias St. Pierre2022-03-101-6/+6
| | | | | | | | | | which replaces the link to the OpenSSL 3.0 Wiki. Reviewed-by: Tomas Mraz <tomas@openssl.org> Reviewed-by: Patrick Steuer <patrick.steuer@de.ibm.com> Reviewed-by: Paul Dale <pauli@openssl.org> Reviewed-by: Richard Levitte <levitte@openssl.org> (Merged from https://github.com/openssl/openssl/pull/17840)
* Unify the markdown links to the NOTES and README filesDr. Matthias St. Pierre2021-02-121-7/+7
| | | | | | | | | | | | | In many locations, the files have been converted to markdown syntactically, but don't utilize the power of markdown yet. Here, instead of just repeating the file name, the markdown link now shows the title of the document. Additionally, the notes are now reference in the same order in both the README and the INSTALL file. Reviewed-by: Paul Dale <pauli@openssl.org> (Merged from https://github.com/openssl/openssl/pull/14042)
* Revise some renamings of NOTES and README filesDr. Matthias St. Pierre2021-02-121-5/+5
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Some of the notes and readme files have been converted to markdown format recently and renamed during this process. While adding the .md extension was a natural step, switching to mixed cases was not a change to the better, it gives them a ragged appearance: NOTES.ANDROID => NOTES-Android.md NOTES.DJGPP => NOTES-DJGPP.md NOTES.PERL => NOTES-Perl.md NOTES.UNIX => NOTES-Unix.md NOTES.VMS => NOTES-VMS.md NOTES.VALGRIND => NOTES-Valgrind.md NOTES.WIN => NOTES-Windows.txt README.ENGINE => README-Engine.md README.FIPS => README-FIPS.md Moreover, the NOTES-Windows.txt file is the only file which has been converted to markdown but has received a .txt file extension. This doesn't make sense, because the OpenSSL users on Windows will need to read the other markdown documents as well. Since they are developers, we can trust them to be able to associate their favorite editor with the .md extension. In fact, having a comment at the beginning of the file saying that it is in markdown format but we didn't dare to add the correct extension in order not to overwhelm our Windows users can be interpreted either as unintentionally funny or disrespectful ;-) This commit suggests the following more consistent renaming: NOTES.ANDROID => NOTES-ANDROID.md NOTES.DJGPP => NOTES-DJGPP.md NOTES.PERL => NOTES-PERL.md NOTES.UNIX => NOTES-UNIX.md NOTES.VMS => NOTES-VMS.md NOTES.VALGRIND => NOTES-VALGRIND.md NOTES.WIN => NOTES-WINDOWS.md README.ENGINE => README-ENGINES.md README.FIPS => README-FIPS.md (note the plural in README-ENGINES, anticipating a README-PROVIDERS) Reviewed-by: Paul Dale <pauli@openssl.org> (Merged from https://github.com/openssl/openssl/pull/14042)
* Update copyright yearRichard Levitte2021-01-281-1/+1
| | | | | Reviewed-by: Tomas Mraz <tomas@openssl.org> (Merged from https://github.com/openssl/openssl/pull/13999)
* Drop TravisRichard Levitte2021-01-251-7/+7
| | | | | | | | At this point, we have transitioned completely from Travis to GitHub Actions Reviewed-by: Tim Hudson <tjh@openssl.org> Reviewed-by: Paul Dale <pauli@openssl.org> (Merged from https://github.com/openssl/openssl/pull/13940)
* README: Move Travis link to .com from .org.J08nY2020-11-281-2/+2
| | | | | | | | | | | CLA: trivial Fixes #12423 Reviewed-by: Richard Levitte <levitte@openssl.org> Reviewed-by: Shane Lontis <shane.lontis@oracle.com> Reviewed-by: Paul Dale <paul.dale@oracle.com> (Merged from https://github.com/openssl/openssl/pull/13538)
* fix typo in READMEIchinose Shogo2020-11-031-1/+1
| | | | | | | | | CLA: trivial Reviewed-by: Paul Dale <paul.dale@oracle.com> Reviewed-by: Kurt Roeckx <kurt@roeckx.be> Reviewed-by: Matthias St. Pierre <Matthias.St.Pierre@ncp-e.com> (Merged from https://github.com/openssl/openssl/pull/13289)
* Change markdown link style in README, INSTALL, SUPPORT and CONTRIBUTINGDr. Matthias St. Pierre2020-10-181-8/+8
| | | | | | | | | | | | | | | Replace [collapsed reference links][] by [shortcut reference links], in order to to improve the readability of the raw markdown text, see also commit d8dc853825 (Change CVE link style in CHANGES and NEWS). [collapsed reference links]: https://github.github.com/gfm/#collapsed-reference-link [shortcut reference links]: https://github.github.com/gfm/#shortcut-reference-link Reviewed-by: Richard Levitte <levitte@openssl.org> (Merged from https://github.com/openssl/openssl/pull/13165)
* README: make the link to the OpenSSL 3.0 Wiki page more prominentDr. Matthias St. Pierre2020-10-181-2/+5
| | | | | | Reviewed-by: Matt Caswell <matt@openssl.org> Reviewed-by: Richard Levitte <levitte@openssl.org> (Merged from https://github.com/openssl/openssl/pull/13164)
* README.md: remove incorrect link to openssl.github.ioDr. Matthias St. Pierre2020-08-111-9/+0
| | | | | | | | | | | | | | | | | | | The link to the OpenSSL Project Pages <openssl.github.io> actually points to an unfinished draft <mspncp.github.io>. The original intention of this pet project of mine was to have a website dedicated to describing the OpenSSL workflow on GitHub and to answer frequently asked questions related to pull requests and the review process. The progress on that project has stalled and I'm not so sure anymore whether it is good idea to have yet another project website. In particular since the OpenSSL Wiki has seen some revival and increased activity caused by the upcoming OpenSSL 3.0 release. Reviewed-by: Matt Caswell <matt@openssl.org> (Merged from https://github.com/openssl/openssl/pull/12361)
* README.md: replace incorrect access token for the AppVeyor badgeDr. Matthias St. Pierre2020-08-111-8/+1
| | | | | | | | | | The AppVeyor badge was still showing the build state for the mspncp/openssl fork. This commit fixes a forgotten todo from #10545. Reviewed-by: Matt Caswell <matt@openssl.org> (Merged from https://github.com/openssl/openssl/pull/12361)
* Fix many MarkDown issues in {NOTES*,README*,HACKING,LICENSE}.md filesDr. David von Oheimb2020-07-051-7/+7
| | | | | Reviewed-by: Tim Hudson <tjh@openssl.org> (Merged from https://github.com/openssl/openssl/pull/12109)
* Rename NOTES*, README*, VERSION, HACKING, LICENSE to .md or .txtDr. David von Oheimb2020-07-051-1/+1
| | | | | Reviewed-by: Tim Hudson <tjh@openssl.org> (Merged from https://github.com/openssl/openssl/pull/12109)
* Fix issues reported by markdownlintRich Salz2020-05-081-34/+24
| | | | | | Reviewed-by: Tomas Mraz <tmraz@fedoraproject.org> Reviewed-by: Matthias St. Pierre <Matthias.St.Pierre@ncp-e.com> (Merged from https://github.com/openssl/openssl/pull/11739)
* Add a link to wiki 3.0 upgrade notesMatt Caswell2020-04-221-0/+3
| | | | | | | | | Provide a link to the 3.0 upgrade notes so that users of the alpha/beta/ final releases can understand the differences between this version and previous versions. Reviewed-by: Nicola Tuveri <nic.tuv@gmail.com> (Merged from https://github.com/openssl/openssl/pull/11587)
* doc: revamp the README fileDr. Matthias St. Pierre2020-02-261-68/+206
| | | | | | | | | * Add an OpenSSL logo and CI badges * Add a table of contents * Add a lot of links Reviewed-by: Tomas Mraz <tmraz@fedoraproject.org> (Merged from https://github.com/openssl/openssl/pull/10545)
* doc: introduce some minimalistic markdown without essential changesDr. Matthias St. Pierre2020-02-261-56/+69
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The goal is to transform the standard documents README, INSTALL, SUPPORT, CONTRIBUTING, ... from a pure text format into markdown format, but in such a way that the documentation remains nicely formatted an easy readable when viewed with an normal text editor. To achieve this goal, we use a special form of 'minimalistic' markdown which interferes as little as possible with the reading flow. * avoid [ATX headings][] and use [setext headings][] instead (works for `<h1>` and `<h2>` headings only). * avoid [inline links][] and use [reference links][] instead. * avoid [fenced code blocks][], use [indented-code-blocks][] instead. The transformation will take place in several steps. This commit introduces mostly changes the formatting and does not chang the content significantly. [ATX headings]: https://github.github.com/gfm/#atx-headings [setext headings]: https://github.github.com/gfm/#setext-headings [inline links]: https://github.github.com/gfm/#inline-link [reference links]: https://github.github.com/gfm/#reference-link [fenced code blocks]: https://github.github.com/gfm/#fenced-code-blocks [indented code blocks]: https://github.github.com/gfm/#indented-code-blocks Reviewed-by: Tomas Mraz <tmraz@fedoraproject.org> (Merged from https://github.com/openssl/openssl/pull/10545)
* doc: convert standard project docs to markdownDr. Matthias St. Pierre2020-02-261-0/+92
| | | | | | | | | In the first step, we just add the .md extension and move some files around, without changing any content. These changes will occur in the following commits. Reviewed-by: Tomas Mraz <tmraz@fedoraproject.org> (Merged from https://github.com/openssl/openssl/pull/10545)
* Undo 77bf69dced875200f6f0e385a4a270298f8d3c45Rich Salz2014-08-111-15/+0
| | | | Not approved; mistakenly pushed commit that added README.md
* Add README.mdRich Salz2014-08-111-0/+15
A small markdown README for GitHub users; points them to the right README and the website and RT tracker.