Skip to content

Latest commit

 

History

History
18 lines (15 loc) · 777 Bytes

README.instructions.md

File metadata and controls

18 lines (15 loc) · 777 Bytes
Raw

Create a top level README.md with the following:

  • Name of the project
  • Graphic of some sort about the product (logo or screenshot or something)
  • Description of the product
  • Table of contents (optional)
  • Instructions about how to download, install, and run the product
  • Instructions on how to use the product
  • Names and github ids of each of the group members
  • License information (point to LICENSE.txt)

Examples:

-https://github.com/openssl/openssl

-https://github.com/apache/echarts

License info

-Create a file named LICENSE.txt and include license information. The MIT license is one good choice. Or you can pick any license you choose. -Create a file named LICENSE.3rdparty  and include license information for any 3rd party code that you use (if any).