Create README.md

gabrielandrade2 · Sep 7, 2023 · 2508410 · 2508410
1 parent aa4535d
commit 2508410
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,13 @@
+# AnonymizationTool
+A simple Anonymization Tool for Japanese texts. (In development)
+
+It uses Mecab POS tagging to identify potential `Proper Nouns` and replace those with a `[ANON]` tag.
+
+## Execution
+
+It can be executed in two main ways currently:
+
+- Executing `gui.py` will initialize a gui to select files and define the parameters
+- To run it in the console, `main.py` can be called, passing the proper parameters.
+
+