aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md22
1 files changed, 15 insertions, 7 deletions
diff --git a/README.md b/README.md
index 153f96c..033a880 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,18 @@
-# My Personal Project
+# apus
-## A subtitle
+## a local web browser
-A *bulleted* list:
-- item 1
-- item 2
-- item 3
+apus (from _Gigantochloa apus_: the most common bamboo on the island of Java) is a local web browser.
+It will parse and display HTML, Markdown, epub, and potentially other XML-based file formats.
+It will not connect to the internet, and instead only parse local files given to it on the command line or eventually uploaded in a user interface.
+Hopefully nobody outside of this class will use it because it will be a standards-failing web browser written in Java Swing.
-An example of text with **bold** and *italic* fonts. \ No newline at end of file
+This project is of interest to me because I enjoy writing parsers and have been meaning to play around with text and image rendering.
+I've heard that Java Swing has a native HTML rendering component. I hope to entirely disregard this, and instead reimplement it poorly.
+
+## user stories
+
+- As a user, I want to open and render an HTML file.
+- As a user, I want to be able to add a new tab to a list of open tabs.
+- As a user, I want to be able to click links on a rendered webpage and view the linked pages.
+- As a user, I want to be able to apply basic styling to an open page. \ No newline at end of file