Skip to content

Commit f0c4b46

Browse files
uilianriesuilianries
committed
Apply Conan Readme Generator [skip ci]
Signed-off-by: Uilian Ries <[email protected]>
1 parent 9933ee4 commit f0c4b46

File tree

2 files changed

+79
-32
lines changed

2 files changed

+79
-32
lines changed

‎LICENSE

+15-4
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,20 @@
1-
Copyright 2017 JFrog LTD
1+
Copyright (c) 2017-2019 JFrog LTD
22

33
MIT LICENSE
44

5-
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
611

7-
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
814

9-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
19+
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
20+
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

‎README.md

+64-28
Original file line numberDiff line numberDiff line change
@@ -1,51 +1,87 @@
1-
[![Build Status](https://travis-ci.org/lasote/conan-openssl.svg?branch=master)](https://travis-ci.org/lasote/conan-openssl)
1+
[![Download](https://api.bintray.com/packages/conan-community/conan/OpenSSL%3Aconan/images/download.svg) ](https://bintray.com/conan-community/conan/OpenSSL%3Aconan/_latestVersion)
2+
[![Build Status Travis](https://travis-ci.org/conan-community/conan-OpenSSL.svg)](https://travis-ci.org/conan-community/conan-OpenSSL)
3+
[![Build Status AppVeyor](https://ci.appveyor.com/api/projects/status/github/conan-community/conan-OpenSSL?svg=true)](https://ci.appveyor.com/project/ConanCIintegration/conan-OpenSSL)
24

3-
[![Join the chat at https://gitter.im/lasote/conan-openssl](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/lasote/conan-openssl?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
5+
## Conan package recipe for *OpenSSL*
46

7+
OpenSSL is an open source project that provides a robust, commercial-grade, and full-featured toolkit for the Transport Layer Security (TLS) and Secure Sockets Layer (SSL) protocols
58

9+
The packages generated with this **conanfile** can be found on [Bintray](https://bintray.com/conan-community/conan/OpenSSL%3Aconan).
610

7-
# conan-openssl
811

9-
[Conan.io](https://conan.io) package for OpenSSL library
12+
## Issues
1013

11-
The packages generated with this **conanfile** can be found in the [conan-center on Bintray](https://bintray.com/conan/conan-center).
14+
If you wish to report an issue or make a request for a package, please do so here:
1215

13-
## Build packages
16+
[Issues Tracker](https://github.com/conan-community/community/issues)
1417

15-
Only necessary if you don't want to use the pre-compiled binaries, and you want to build your own packages from source.
1618

17-
Download conan client from [Conan.io](https://conan.io) and run:
18-
19-
$ conan test_package
20-
$ conan test_package # use different settings, options or profiles
21-
22-
## Upload packages to server
23-
24-
$ conan upload OpenSSL/1.0.2n@conan/stable --all
25-
26-
## Reuse the packages
19+
## For Users
2720

2821
### Basic setup
2922

30-
$ conan install OpenSSL/1.0.2n@conan/stable
31-
23+
$ conan install OpenSSL/1.1.1a@conan/stable
24+
3225
### Project setup
3326

3427
If you handle multiple dependencies in your project is better to add a *conanfile.txt*
35-
28+
3629
[requires]
37-
OpenSSL/1.0.2n@conan/stable
30+
OpenSSL/1.1.1a@conan/stable
3831

39-
[options]
40-
OpenSSL:shared=false # true
41-
# Take a look for all available options in conanfile.py
42-
4332
[generators]
4433
txt
45-
cmake
4634

4735
Complete the installation of requirements for your project running:
4836

49-
conan install .
37+
$ mkdir build && cd build && conan install ..
38+
39+
Note: It is recommended that you run conan install from a build directory and not the root of the project directory. This is because conan generates *conanbuildinfo* files specific to a single build configuration which by default comes from an autodetected default profile located in ~/.conan/profiles/default . If you pass different build configuration options to conan install, it will generate different *conanbuildinfo* files. Thus, they should not be added to the root of the project, nor committed to git.
40+
41+
42+
## Build and package
43+
44+
The following command both runs all the steps of the conan file, and publishes the package to the local system cache. This includes downloading dependencies from "build_requires" and "requires" , and then running the build() method.
45+
46+
$ conan create . conan/stable
47+
48+
49+
### Available Options
50+
| Option | Default | Possible Values |
51+
| ------------- |:----------------- |:------------:|
52+
| no_threads | False | [True, False] |
53+
| no_zlib | False | [True, False] |
54+
| shared | False | [True, False] |
55+
| no_asm | False | [True, False] |
56+
| 386 | False | [True, False] |
57+
| no_sse2 | False | [True, False] |
58+
| no_bf | False | [True, False] |
59+
| no_cast | False | [True, False] |
60+
| no_des | False | [True, False] |
61+
| no_dh | False | [True, False] |
62+
| no_dsa | False | [True, False] |
63+
| no_hmac | False | [True, False] |
64+
| no_md2 | False | [True, False] |
65+
| no_md5 | False | [True, False] |
66+
| no_mdc2 | False | [True, False] |
67+
| no_rc2 | False | [True, False] |
68+
| no_rc4 | False | [True, False] |
69+
| no_rc5 | False | [True, False] |
70+
| no_rsa | False | [True, False] |
71+
| no_sha | False | [True, False] |
72+
| no_fpic | False | [True, False] |
73+
74+
75+
## Add Remote
76+
77+
Conan Community has its own Bintray repository, however, we are working to distribute all package in the Conan Center:
78+
79+
$ conan remote add conan-center "https://conan.bintray.com"
80+
81+
82+
## Conan Recipe License
83+
84+
NOTE: The conan recipe license applies only to the files of this recipe, which can be used to build and package OpenSSL.
85+
It does *not* in any way apply or is related to the actual software being packaged.
5086

51-
Project setup installs the library (and all its dependencies) and generates the files *conanbuildinfo.txt* and *conanbuildinfo.cmake* with all the paths and variables that you need to link with your dependencies.
87+
[MIT](LICENSE)

0 commit comments

Comments
 (0)