category-cycles: add README

siddharthvp · Feb 6, 2021 · f1f9dfd · f1f9dfd
1 parent 9019ff1
commit f1f9dfd
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/category-cycles/README.md b/category-cycles/README.md
@@ -0,0 +1,12 @@
+## Category cycles
+
+Used to generate [User:SDZeroBot/Category_cycles](https://en.wikipedia.org/wiki/User:SDZeroBot/Category_cycles). 
+
+Run using `bash run.sh`.
+
+Files:
+- get_edges.sql: Get a list of all parentcat—subcat connections through the database, with only the category page IDs for efficiency in the next step.
+- find_cycles.cpp: Use depth-first search in the graph to detect the cycles.
+- prettify.js: Translate the page IDs to titles using the API, and publish report to wiki.
+
+[phab:T263096](https://phabricator.wikimedia.org/T263096) seeks to make such a script a part of MediaWiki.