File tree 3 files changed +60
-0
lines changed
3 files changed +60
-0
lines changed Original file line number Diff line number Diff line change
1
+ To report a problem with this guide please open an issue on GitHub.
2
+
3
+ To submit a minor patch to this guide please open a pull request on GitHub. Note
4
+ that we do not accept merge commits; You will be asked to remove them before a
5
+ patch is considered acceptable.
6
+
7
+ To contribute significant content (e.g. a new chapter) you should also open a
8
+ pull request on GitHub. However please discuss the outline of your chapter
9
+ content on the openssl-dev email list before starting work (see
10
+ https://mta.openssl.org for details).
Original file line number Diff line number Diff line change
1
+ The License is TBD. It will most likely be one of
2
+
3
+ Apache v2 License
4
+ CC-BY 4.0
5
+ The OpenSSL License
6
+
7
+ Please only contribute to this project if you are willing for your content to be
8
+ licensed using one of the above or a similar Open Source license.
Original file line number Diff line number Diff line change
1
+ Copyright 2017 The OpenSSL Project Authors. All Rights Reserved.
2
+
3
+ Overview
4
+ ========
5
+
6
+ The OpenSSL Guide is an attempt to create better documentation for the OpenSSL
7
+ Toolkit. Until now the following types of documentation exist:
8
+
9
+ 1) Man pages
10
+ 2) Wiki
11
+
12
+ The man pages are a reference guide and useful for looking up the specific usage
13
+ of a particular command or function. The wiki is a an unreviewed community
14
+ resource which may contain content on a wide range of subjects. Typically this
15
+ content is relatively short and focussed on a particular subject area. The wiki
16
+ is intended to have a relatively low barrier of entry to encourage community
17
+ collaboration.
18
+
19
+ This book is intended to fill a "gap" in this documentation, i.e. to provide a
20
+ definitive, trusted source of introductory and "guide" style material that will
21
+ enable a reader who is unfamiliar with OpenSSL to learn more about it. It will
22
+ contain content that should enable the reader to get to a level of familiarity
23
+ with OpenSSL that they can then use the other documentation sources (such as the
24
+ man pages) to find detailed information as required.
25
+
26
+ NOTE: This is a very initial draft and there is no content in the guide yet!
27
+
28
+ Building the OpenSSL Guide
29
+ ==========================
30
+
31
+ The following prerequisites are needed in order to build the guide:
32
+
33
+ - TeX Live
34
+ - gcc
35
+ - make
36
+
37
+ Assuming you have all of the above installed on your system, then creating the
38
+ guide is simply a matter of typing "make" from the command line:
39
+
40
+ $ make
41
+
42
+ The output should be "openssl-book.pdf".
You can’t perform that action at this time.
0 commit comments