41 Commits

Author	SHA1	Message	Date
Jonathan Reimer	c676cd92b1	Add Linux Foundation Health Score badge to README ... CLA: trivial Reviewed-by: Shane Lontis <shane.lontis@oracle.com> Reviewed-by: Tomas Mraz <tomas@openssl.org> (Merged from https://github.com/openssl/openssl/pull/28614)	2025-09-23 16:46:57 +02:00
operagxoksana	8ad37051e2	README.md: Improve links to GH workflow badges ... CLA: trivial Reviewed-by: Shane Lontis <shane.lontis@oracle.com> Reviewed-by: Tomas Mraz <tomas@openssl.org> (Merged from https://github.com/openssl/openssl/pull/27596)	2025-05-29 16:32:54 +02:00
Jon Ericson	f014892d9f	Point to new docs location ... Reviewed-by: Tomas Mraz <tomas@openssl.org> Reviewed-by: Paul Dale <ppzgs1@gmail.com> Reviewed-by: Matt Caswell <matt@openssl.org> (Merged from https://github.com/openssl/openssl/pull/27331)	2025-04-15 15:56:16 +01:00
Sebastian Andrzej Siewior	648366ad01	README: Remove client only restriction for QUIC. ... The QUIC protocol is also supported on server side. Update the README file accordingly. Signed-off-by: Sebastian Andrzej Siewior <sebastian@breakpoint.cc> Reviewed-by: Tomas Mraz <tomas@openssl.org> Reviewed-by: Matt Caswell <matt@openssl.org> Reviewed-by: Paul Dale <ppzgs1@gmail.com> Reviewed-by: Neil Horman <nhorman@openssl.org> (Merged from https://github.com/openssl/openssl/pull/27258)	2025-04-05 09:16:54 -04:00
Jon Ericson	da8de0e8dd	Change documentation to point to new wiki location ... Reviewed-by: Matt Caswell <matt@openssl.org> Reviewed-by: Tomas Mraz <tomas@openssl.org> (Merged from https://github.com/openssl/openssl/pull/27081)	2025-03-25 20:24:48 +01:00
openssl-machine	0c679f5566	Copyright year updates ... Reviewed-by: Neil Horman <nhorman@openssl.org> Reviewed-by: Matt Caswell <matt@openssl.org> Release: yes	2025-03-12 13:35:59 +00:00
Tom Cosgrove	5f9814d95c	Remove references to git.openssl.org from README.md ... Reviewed-by: Saša Nedvědický <sashan@openssl.org> Reviewed-by: Matt Caswell <matt@openssl.org> Reviewed-by: Tomas Mraz <tomas@openssl.org> (Merged from https://github.com/openssl/openssl/pull/26122)	2024-12-10 10:38:15 +01:00
spectre	6f2c97d50a	README.md: Fix typo. Change 'the are' to 'there are' ... This pull request fixes a typo in the documentation. The phrase "the are" has been corrected to "there are". CLA: trivial Reviewed-by: Matt Caswell <matt@openssl.org> Reviewed-by: Tom Cosgrove <tom.cosgrove@arm.com> Reviewed-by: Tomas Mraz <tomas@openssl.org> (Merged from https://github.com/openssl/openssl/pull/25977)	2024-11-20 17:23:10 +01:00
Neil Horman	e7e48e7f6c	Add interop status badge ... Reviewed-by: Viktor Dukhovni <viktor@openssl.org> Reviewed-by: Tomas Mraz <tomas@openssl.org> (Merged from https://github.com/openssl/openssl/pull/25256)	2024-09-10 11:38:09 -04:00
Neil Horman	f96563297e	Add badges for daily checks and provider compat ... Reviewed-by: Richard Levitte <levitte@openssl.org> Reviewed-by: Paul Dale <ppzgs1@gmail.com> (Merged from https://github.com/openssl/openssl/pull/24762)	2024-06-30 08:18:03 -04:00
Neil Horman	fccefa7016	Remove appveyor badge and replace it with os zoo badge ... We don't use appveyor anymore. Replace it with the os zoo badge, so we can more persistently see when its breaking Reviewed-by: Richard Levitte <levitte@openssl.org> Reviewed-by: Paul Dale <ppzgs1@gmail.com> (Merged from https://github.com/openssl/openssl/pull/24762)	2024-06-30 08:18:03 -04:00
Richard Levitte	b646179229	Copyright year updates ... Reviewed-by: Neil Horman <nhorman@openssl.org> Release: yes (cherry picked from commit 0ce7d1f355) Reviewed-by: Hugo Landau <hlandau@openssl.org> Reviewed-by: Tomas Mraz <tomas@openssl.org> (Merged from https://github.com/openssl/openssl/pull/24034)	2024-04-09 13:43:26 +02:00
Matthias St. Pierre	4f0172c543	README: add link to OpenSSL 3.2 manual pages ... Reviewed-by: Richard Levitte <levitte@openssl.org> Reviewed-by: Shane Lontis <shane.lontis@oracle.com> (Merged from https://github.com/openssl/openssl/pull/22625)	2023-11-15 08:37:21 +01:00
Matt Caswell	ada33e98f5	Add a separate README for the guide demos ... Point users at the actual guide, and also explain about LD_LIBRARY_PATH Reviewed-by: Hugo Landau <hlandau@openssl.org> Reviewed-by: Tomas Mraz <tomas@openssl.org> (Merged from https://github.com/openssl/openssl/pull/22505)	2023-10-30 07:54:00 +00:00
Matt Caswell	899c910e34	Add a reference to the demos subfolder ... Reviewed-by: Hugo Landau <hlandau@openssl.org> Reviewed-by: Tomas Mraz <tomas@openssl.org> (Merged from https://github.com/openssl/openssl/pull/22505)	2023-10-30 07:53:40 +00:00
Matt Caswell	0181a1a49c	Refresh the README.md file ... Reviewed-by: Hugo Landau <hlandau@openssl.org> Reviewed-by: Tomas Mraz <tomas@openssl.org> (Merged from https://github.com/openssl/openssl/pull/22505)	2023-10-30 07:53:40 +00:00
Matthias St. Pierre	27315a978e	doc: add the migration guide to the new guide series ... Reviewed-by: Hugo Landau <hlandau@openssl.org> Reviewed-by: Matt Caswell <matt@openssl.org> (Merged from https://github.com/openssl/openssl/pull/21807)	2023-08-23 18:17:53 +01:00
Dimitri Papadopoulos	c5f55a4605	Consistency: "Authors" after "The OpenSSL Project" ... All source files show "The OpenSSL Project Authors" as the copyright owner. Reviewed-by: Tom Cosgrove <tom.cosgrove@arm.com> Reviewed-by: Richard Levitte <levitte@openssl.org> Reviewed-by: Paul Dale <pauli@openssl.org> (Merged from https://github.com/openssl/openssl/pull/21268)	2023-06-26 07:58:03 +10:00
Preveen Padmanabhan	7197abddb8	updated the end copyright year in README.md to 2023 ... CLA: trivial Reviewed-by: Todd Short <todd.short@me.com> Reviewed-by: Richard Levitte <levitte@openssl.org> Reviewed-by: Paul Dale <pauli@openssl.org> (Merged from https://github.com/openssl/openssl/pull/21225)	2023-06-21 20:19:56 +10:00
Thiago Suchorski	af33b200da	Fixed some grammar and spelling ... Reviewed-by: Richard Levitte <levitte@openssl.org> Reviewed-by: Tomas Mraz <tomas@openssl.org> Reviewed-by: Matthias St. Pierre <Matthias.St.Pierre@ncp-e.com> (Merged from https://github.com/openssl/openssl/pull/19262)	2022-10-09 17:40:29 +02:00
Dr. Matthias St. Pierre	a20c9b6c13	README: add missing link to OpenSSL 3.0 manual pages ... 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)	2022-03-11 14:27:54 +11:00
Dr. Matthias St. Pierre	96a7766172	README: add link to migration_guide manual page ... 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)	2022-03-10 14:05:59 +01:00
Dr. Matthias St. Pierre	4148581eb2	Unify the markdown links to the NOTES and README files ... 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)	2021-02-12 20:41:32 +01:00
Dr. Matthias St. Pierre	9f1fe6a950	Revise some renamings of NOTES and README files ... 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)	2021-02-12 20:35:26 +01:00
Richard Levitte	4333b89f50	Update copyright year ... Reviewed-by: Tomas Mraz <tomas@openssl.org> (Merged from https://github.com/openssl/openssl/pull/13999)	2021-01-28 13:54:57 +01:00
Richard Levitte	b897b353df	Drop Travis ... 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)	2021-01-25 13:41:23 +01:00
J08nY	be501dd556	README: Move Travis link to .com from .org. ... 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)	2020-11-28 15:38:12 +10:00
Ichinose Shogo	3ee3c4d2ab	fix typo in README ... 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)	2020-11-03 17:58:12 +01:00
Dr. Matthias St. Pierre	6c8149df1f	Change markdown link style in README, INSTALL, SUPPORT and CONTRIBUTING ... 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)	2020-10-18 13:28:08 +02:00
Dr. Matthias St. Pierre	84dd002f41	README: make the link to the OpenSSL 3.0 Wiki page more prominent ... Reviewed-by: Matt Caswell <matt@openssl.org> Reviewed-by: Richard Levitte <levitte@openssl.org> (Merged from https://github.com/openssl/openssl/pull/13164)	2020-10-18 13:24:26 +02:00
Dr. Matthias St. Pierre	36b778fbb7	README.md: remove incorrect link to openssl.github.io ... 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)	2020-08-11 12:28:02 +02:00
Dr. Matthias St. Pierre	0799b79a45	README.md: replace incorrect access token for the AppVeyor badge ... 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)	2020-08-11 12:28:02 +02:00
Dr. David von Oheimb	1dc1ea182b	Fix many MarkDown issues in {NOTES*,README*,HACKING,LICENSE}.md files ... Reviewed-by: Tim Hudson <tjh@openssl.org> (Merged from https://github.com/openssl/openssl/pull/12109)	2020-07-05 11:29:43 +02:00
Dr. David von Oheimb	036cbb6bbf	Rename NOTES*, README*, VERSION, HACKING, LICENSE to .md or .txt ... Reviewed-by: Tim Hudson <tjh@openssl.org> (Merged from https://github.com/openssl/openssl/pull/12109)	2020-07-05 11:29:43 +02:00
Rich Salz	257e9d03b0	Fix issues reported by markdownlint ... 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)	2020-05-08 16:22:02 +02:00
Matt Caswell	75dbc66e60	Add a link to wiki 3.0 upgrade notes ... 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)	2020-04-22 10:21:56 +01:00
Dr. Matthias St. Pierre	dac5138e13	doc: revamp the README file ... * 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)	2020-02-26 21:04:38 +01:00
Dr. Matthias St. Pierre	5f8e6c50bd	doc: introduce some minimalistic markdown without essential changes ... 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)	2020-02-26 21:04:38 +01:00
Dr. Matthias St. Pierre	2e07506a12	doc: convert standard project docs to markdown ... 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)	2020-02-26 21:04:38 +01:00
Rich Salz	cbfc8baddb	Undo 77bf69dced ... Not approved; mistakenly pushed commit that added README.md	2014-08-11 13:44:25 -04:00
Rich Salz	77bf69dced	Add README.md ... A small markdown README for GitHub users; points them to the right README and the website and RT tracker.	2014-08-11 11:35:32 -04:00