diff --git a/README.md b/README.md new file mode 100644 index 000000000..f178f87d8 --- /dev/null +++ b/README.md @@ -0,0 +1,8 @@ +![website status](https://img.shields.io/website?url=https%3A%2F%2Ftranslations.python.org&logoColor=yellow&label=website%20status) +[![lint](https://github.com/python-docs-translations/dashboard/actions/workflows/lint.yml/badge.svg)](https://github.com/python-docs-translations/dashboard/actions/workflows/lint.yml) + +This project generates a dashboard presenting the Python documentation translations projects. + +There are two entrypoints: +- `generate.py`: Generates dashboard HTML and JSON files. +- `generate_build_details.py`: Generates the build details HTML file and log files for each translation project.