From 845866ef9d80109397d261afebb3e991257e4591 Mon Sep 17 00:00:00 2001 From: deadvey Date: Sun, 26 Jan 2025 11:15:34 +0000 Subject: [PATCH] readme --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.md b/README.md index 5759334..ab11e3b 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,25 @@ A web browser that let's you browse 'mttp' websites that use markdown as a superior standard to html Fully static! +# Getting a website on this +The default port is 3477, though you can use any port as long as you specify it in the url. +You need a tag at the start of any markdown files so the browser know's which files are markdown and which are other generic text files. + +# Help +Type h in the program to see this text: +``` +Source code: https://git.javalsai.dynv6.net/deadvey/markdown-webbrowser +q: quit +h: help +r: reload +s: view source code of page +i: visit root index of this host eg: root index of mttp://deadvey.com/blog/4.md is just deadvey.com +b: go back in history +f: go forward in history +ox: print the hyprlink of reference x eg: o5 or o24 +[url]: follow the inputed url +``` + # Example: ![screenshot](/images/screenshot.png)