IEEE.org     |     IEEE Xplore Digital Library     |     IEEE Standards     |     IEEE Spectrum     |     More Sites

Commit a9ddfb2f authored by Joshua Gay's avatar Joshua Gay 💾
Browse files

added emoji

parent 17948cb3
......@@ -15,22 +15,34 @@ Additional files you may want to have or may need to have:
## README
Your project's README file should provide at minimum information about your project, how to contribute (including license/CLA info), and who the project's lead and/or maintainers. Some additional sections and info are recommended. Below is a list of various recommended sections.
Your project's README file should provide at minimum information about
your project, how to contribute (including license/CLA info), and a
list of the project's lead(s) and/or maintainer(s). Some additional
sections and info are recommended. Below is a list of various
recommended sections.
* About
Also, have fun. Use emoji. Being friendly and welcoming.
* :mag_right: About
* 1-2 paragraphs describing the purpose of the project
* Getting Started
* Requirements or preconditions needed to install the software or any assumptions.
* Instructions (step-by-step guide) to get a copy of the project up and running on a peron's local machine for use, development, and/or testing.
* :checkered_flag: Getting Started
* :hammer_and_wrench: Requirements or preconditions needed to install the software or any assumptions.
* :page_with_curl: Instructions (step-by-step guide) to get a copy of the project up and running on a peron's local machine for use, development, and/or testing.
* Usage - any additional usage notes on using the software
* Project leadership
* :unicorn: Project leadership
* Project Lead (username)
* Project maintainer name (username)
* Contributing
* :gift: :tada: Contributing
* This project is licensed under the terms of the (LICENSE NAME). Contributions are accepted under a Contributor License Agreement (LINK to appropriate project https://opensource.ieee.org/community/cla/). See (LINK to contributing.md) for more
* Communications
* :speech_balloon: Communicating
* Link to any mailing list
* Link to public mattermost channel
* Acknowledgements
* See CONTRIBUTORS.md for a list of contributors and AUTHORS.md for a list of authors.
* Any additional thanks, etc. you wish to add (e.g., another project that provided inspiration, etc).
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment