summaryrefslogtreecommitdiff
path: root/readme.md
diff options
context:
space:
mode:
authorAarontheissueguy2021-02-20 20:03:09 +0100
committerGitHub2021-02-20 20:03:09 +0100
commitebfeb5d51e5e31195053b8ed714762ae6b0d2060 (patch)
treee4bf1a7a59b5e2d7ca5d65abbcd0683d3e0b608a /readme.md
Initial commit
Diffstat (limited to 'readme.md')
-rw-r--r--readme.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..f9522eb
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,4 @@
+# Html2Gemini
+This simple python programm allows you to convert html to fully usable gmi files.
+Using it is fairly simple. install md2gemini and markdownify with pip before you start.
+Now place your entire site in the input folder (the script will filter it for html files). Run main.py with python 3 and wait untill it is done. You will now find your .gmi files in the output/gemini folder. You can simply run a server with those files and everything should work. This is script is intended to be used on html and text heavy sites. PHP files will not be converted. Codeblocks are somewhat buggy from time to time.