From 3588a9a4211d45e2667864b4db9a70f6b8e7f899 Mon Sep 17 00:00:00 2001 From: Uilian Ries Date: Thu, 18 Mar 2021 15:33:08 -0300 Subject: [PATCH] (#4955) Try to improve README visibility Signed-off-by: Uilian Ries --- README.md | 29 +++++++++++++++++++---------- 1 file changed, 19 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index ed888a30c2..4271f733a4 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ - +

+ +

-This is the source index of recipes of the [ConanCenter](https://conan.io/center) package repository. +Conan Center Index is the source index of recipes of the [ConanCenter](https://conan.io/center) package repository for [Conan](https://conan.io). This 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). @@ -12,27 +14,34 @@ All the documentation is available in this same repository in the [`docs/` subfo This is a list of shortcuts to some interesting topics: -* If you want to learn how to **contribute new recipes**, please read [docs/how_to_add_packages.md](docs/how_to_add_packages.md). -* **FAQ**: most common questions are listed in [docs/faqs.md](docs/faqs.md). -* The conan-center **hook errors** reported by CCI Bot can be found in the [docs/error_knowledge_base.md](docs/error_knowledge_base.md). -* The internal changes related to infrastructure can be checked in [docs/changelog.md](docs/changelog.md). -* There are various community lead innitiatives which are outlined in [docs/community_resources.md](docs/community_resources.md). +* :rocket: If you want to learn how to **contribute new recipes**, please read [docs/how_to_add_packages.md](docs/how_to_add_packages.md). +* :speech_balloon: **FAQ**: most common questions are listed in [docs/faqs.md](docs/faqs.md). +* :warning: The conan-center **hook errors** reported by CCI Bot can be found in the [docs/error_knowledge_base.md](docs/error_knowledge_base.md). +* :hammer_and_wrench: The internal changes related to infrastructure can be checked in [docs/changelog.md](docs/changelog.md). +* :world_map: There are various community lead initiatives which are outlined in [docs/community_resources.md](docs/community_resources.md). ### Reporting Issues You can open issues in the [issue tracker](https://github.com/conan-io/conan-center-index/issues) to: -- Report **bugs/issues** in a package: +* :bug: 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... -- Request a **new library** to be added: + +* :bulb: Request a **new library** to be added: - Use the `[request]` label to search the library in the issue tracker in case the it was already requested. - If not, use the same `[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: + +* :robot: Report **a failure** in the CI system: - 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`. Thanks! + + +### License + +[MIT](LICENSE)