README and .gitignore after infra revamp #228

rffontenelle · rffontenelle · commit 142a6bf45d75 · 2024-09-06T00:30:45.000-03:00
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,9 @@
+# we want only the PO files
+*.mo
+*.po~
+
+# cpython checkout shouldn't be added
+cpython/
+
+# do not include potodo temporary file
+.potodo/
diff --git a/README.md b/README.md
@@ -1,24 +1,19 @@
 # Brazilian Portuguese Translation of the Python Documentation
 
-![Build and update documentation](https://github.com/python/python-docs-pt-br/workflows/Build%20and%20update%20documentation/badge.svg)
+[![Workflow status badge][workflow_badge]][workflow_url]
+[![Translation statistics badge][stats_badge]][transifex_url]
 
-## Documentation Contribution Agreement
+Translation files for [Python 3.8 docs][docs_url].
 
-NOTE REGARDING THE LICENSE FOR TRANSLATIONS: Python's documentation is
-maintained using a global network of volunteers. By posting this
-project on Transifex, GitHub, and other public places, and inviting
-you to participate, we are proposing an agreement that you will
-provide your improvements to Python's documentation or the translation
-of Python's documentation for the PSF's use under the CC0 license
-(available at
-https://creativecommons.org/publicdomain/zero/1.0/legalcode). In
-return, you may publicly claim credit for the portion of the
-translation you contributed and if your translation is accepted by the
-PSF, you may (but are not required to) submit a patch including an
-appropriate annotation in the Misc/ACKS or TRANSLATORS file. Although
-nothing in this Documentation Contribution Agreement obligates the PSF
-to incorporate your textual contribution, your participation in the
-Python community is welcomed and appreciated.
+See list of incomplete translations in the [potodo.md][potodo] file.
+
+See [main][main] branch for scripts, docs, license and more info.
+
+[main]: https://github.com/python/python-docs-pt-br/tree/3.8
+[potodo]: potodo.md?plain=1
+[docs_url]: https://docs.python.org/pt-br/3.8/
+[workflow_badge]: https://github.com/python/python-docs-pt-br/workflows/python-38/badge.svg
+[workflow_url]: https://github.com/python/python-docs-pt-br/actions?workflow=python-38
+[stats_badge]: https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fgithub.com%2Fpython%2Fpython-docs-pt-br%2Fraw%2F3.8%2Fstats.json&query=translation&label=pt_BR
+[transifex_url]: https://app.transifex.com/python-doc/python-newest/
 
-You signify acceptance of this agreement by submitting your work to
-the PSF for inclusion in the documentation.
