diff --git a/README.md b/README.md index ab11e3b..f4ac32f 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,24 @@ # Markdown web browser -A web browser that let's you browse 'mttp' websites that use markdown as a superior standard to html -Fully static! +A web browser that let's you browse gemini capsules that use gemtext as a superior standard to html. -# 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. +# Requirements +- gemget + +# Installing +## Build from source: +- Clone the repo +```cargo run -r``` # Help Type h in the program to see this text: ``` Source code: https://git.javalsai.dynv6.net/deadvey/markdown-webbrowser q: quit +d: debug info 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 +i: visit root index of this host eg: root index of gemini://deadvey.com/blog/4.md is just gemini://deadvey.com b: go back in history f: go forward in history ox: print the hyprlink of reference x eg: o5 or o24 @@ -25,6 +29,8 @@ ox: print the hyprlink of reference x eg: o5 or o24 ![screenshot](/images/screenshot.png) # TO DO +- Make pages scrollable +- Bookmarks - Properly comment it because I can't lie I can't even follow it. - Make it memory safe, it crashes if the input is unexpected. - Use treesitter instead of Regex, because, reasons. diff --git a/src/main.rs b/src/main.rs index fc3a3ea..f5b7cb4 100644 --- a/src/main.rs +++ b/src/main.rs @@ -188,7 +188,7 @@ d: debug info 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 +i: visit root index of this host eg: root index of gemini://deadvey.com/blog/4.md is just gemini://deadvey.com b: go back in history f: go forward in history ox: print the hyprlink of reference x eg: o5 or o24