From b88dafbb5000eead2e0f35d72ba41dacfef769c8 Mon Sep 17 00:00:00 2001 From: danimtb Date: Thu, 19 Mar 2020 15:15:38 +0100 Subject: [PATCH] proofread --- README.md | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index f9b57588f7..0d35598bb5 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,14 @@ -# ConanCenter Index - ![JFrogConanCenter](assets/JFrogConanCenter.png) -[This repository](https://github.com/conan-io/conan-center-index): +[This repository](https://github.com/conan-io/conan-center-index) in the index of recipes of the +[ConanCenter](https://bintray.com/conan/conan-center) repository. - - Contains the Conan recipes for the [conan-center](https://bintray.com/conan/conan-center) repository. - - Has a CI system that will build automatically the Binary packages for the recipes submitted in a [Pull Request](https://github.com/conan-io/conan-center-index/pulls). +The repository includes a Continuous Integration system that will build automatically the Conan packages for the recipes submitted via +[Pull Request](https://github.com/conan-io/conan-center-index/pulls). -### Check [the Wiki of the project](https://github.com/conan-io/conan-center-index/wiki) to read what is the `Conan-Center-Index`, how it works and how to contribute with new recipes. +### You can learn how to contribute new recipes and how this build service works in [the wiki of the project](https://github.com/conan-io/conan-center-index/wiki) ### Reporting Issues @@ -17,14 +16,15 @@ You can open an issue to: - Report **bugs/issues** in a package: - - Use the [package] tag in the title of the issue to help identifying them. - - If you detect any issue or missing feature in a package, for example, a build failure or a recipe that not support a specific configuration. - - Specify the name and version `zlib/1.2.11` and any relevant details about the fail configuration: Applied profile, building machine... + - Use the `[package]` tag in the title of the issue to help identifying them. + - If you detect any issue or missing feature in a package, for example, a build failure or a recipe that not support a specific configuration. + - Specify the name and version (`zlib/1.2.11`) and any relevant details about the fail configuration: Applied profile, building machine... - Request a **new library** to be added: - - Use the [request] tag in the title of the issue to help identifying them. - - Indicate the name and the version of the library you would like to have in the repository. Also links to the project website, source download/repository and in general any relevant information that helps creating a recipe for the requested library. + - Use the `[request]` tag in the title of the issue to help identifying them. + - Indicate the name and the version of the library you would like to have in the repository. Also links to the project's website, + source download/repository and in general any relevant information that helps creating a recipe for it. - Report **a failure** in the CI system: - - If you open a PR and get an unexpected error you might comment in the failing PR. - - If the service or repository is down or failing, use the [service] tag in the title of a new issue to help identifying them. + - If you open a Pull Request and get an unexpected error you might comment in the failing PR. + - If the service or repository is down or failing, use the `[service]` tag in the title of a new issue to help identifying them. -* If your issue is not appropriate for a public discussion, please contact us via e-mail at info@conan.io. +* If your issue is not appropriate for a public discussion, please contact us via e-mail at ``info@conan.io`. Thanks!