CONTRIBUTING.md

Contributing

Please feel free to submit issues and pull requests. You should add/update repositories under the data/ folder, this README file is automaticly generated and should not be edited.

Data Format

For repository owner/name, create a file named owner.name.json with the following format:

{
	"path": "owner/name",
	"description": "",
	"icon": "zap",
	"topics": ["Topic Name"]
}

• path is a string that represents the path of the repository.
• description is a string that represents the description of the repository, it should not end with a period (the period will be added by the script).
• icon is a string that indicates if the repository should what mark, it can be an empty string or one of:
  • zap (:zap:): which is usually given to 10K starred repositories and recognized repositories in its field.
  • construction (:construction:) given to potential repositories that aren't production ready or have less than 2K stars. It's OK to use them in hobby projects.
• topics is an array of strings that represent the topics of the repository.

Example

{
	"path": "fmtlib/fmt",
	"description": "A modern formatting library",
	"icon": "zap",
	"topics": ["Formatting"]
}

Generating README

We use src/main.cpp to generate the README file, you can compile it with

g++ -std=c++17 -Wall -Wextra -o main.out src/main.cpp -lfmt

And then run it with

./main.out > README.md

This will generate the README file with the correct format. If you can't compile/run it locally, you can submit it to GitHub and wait for me to generate it.