From cc3c9cb35b72659f721123ad536516a24809dc14 Mon Sep 17 00:00:00 2001 From: Abhijeet Kasurde Date: Thu, 11 Jun 2020 03:27:23 +0530 Subject: [PATCH] Update README.md and LICENSE (#70) Signed-off-by: Abhijeet Kasurde --- README.md | 60 +++++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 58 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index cea6e6c6ca..b39d344e44 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,60 @@ [![GitHub Actions CI/CD build status — Collection test suite](https://github.com/ansible-collection-migration/community.general/workflows/Collection%20test%20suite/badge.svg?branch=master)](https://github.com/ansible-collection-migration/community.general/actions?query=workflow%3A%22Collection%20test%20suite%22) -Ansible Collection: community.general -================================================= \ No newline at end of file +# Ansible Collection: community.general + +This repo contains the `community.general` Ansible Collection. + +The collection includes the modules and plugins supported by Ansible community. + + +## Installation and Usage + +### Installing the Collection from Ansible Galaxy + +Before using the General community collection, you need to install the collection with the `ansible-galaxy` CLI: + + ansible-galaxy collection install community.general + +You can also include it in a `requirements.yml` file and install it via `ansible-galaxy collection install -r requirements.yml` using the format: + +```yaml +collections: +- name: community.general +``` + +## Testing and Development + +If you want to develop new content for this collection or improve what is already here, the easiest way to work on the collection is to clone it into one of the configured [`COLLECTIONS_PATHS`](https://docs.ansible.com/ansible/latest/reference_appendices/config.html#collections-paths), and work on it there. + +You can find more information in the [developer guide for collections](https://docs.ansible.com/ansible/devel/dev_guide/developing_collections.html#contributing-to-collections) + +### Testing with `ansible-test` + +See [here](https://docs.ansible.com/ansible/devel/dev_guide/developing_collections.html#testing-collections). + +## Publishing New Version + +TBD + +## More Information + +TBD + +## Communication + +We have a dedicated Working Group for Ansible development. + +You can find other people interested on the following Freenode IRC channels - +- `#ansible` - For general use questions and support. +- `#ansible-devel` - For discussions on developer topics and code related to features or bugs. +- `#ansible-community` - For discussions on community topics and community meetings. + +For more information about communities, meetings and agendas see [Community Wiki](https://github.com/ansible/community/wiki/Community). + +For more information about [communication](https://docs.ansible.com/ansible/latest/community/communication.html) + +## License + +GNU General Public License v3.0 or later + +See [LICENSE](COPYING) to see the full text.