diff --git a/readme b/readme deleted file mode 100644 index fb2286c..0000000 --- a/readme +++ /dev/null @@ -1,35 +0,0 @@ -rose browser ------------- - -Simple webkitgtk browser. - -requirements ------------- - -In order to build rose you need gtk4 and webkit2gtk-5.0. - -Binary file: 28k -Webkit: 80MB -Gtk: 50MB - -In order to use the functionalities: - - video support: gst-libav, gst-plugins-good - - searchbar/find/history: dmenu - - tabs: tabbed - - download: aria2c - -installation ------------- - -Run following command to build and install -(if necessary as root): - - make clean install - -usage ------ - -To set default homepage change config.h - -Opening new window with specific website: - rose https://duckduckgo.com diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..fe2f2f8 --- /dev/null +++ b/readme.md @@ -0,0 +1,31 @@ +
Simple browser based on webkit2-5.0/GTK4.
+ +## Showcase + + + + +## Requirements +In order to build rose you need gtk4 and webkit2gtk-5.0. + +In order to use the functionalities: + - video support: gst-libav, gst-plugins-good + - searchbar/find/history: dmenu + - tabs: tabbed + - download: aria2c + +## Installation + +Run following command to build and install +(if necessary as root): + +```$ make clean install``` + +## usage + +To set default homepage change config.h + +Opening new window with specific website: + +```$ rose https://duckduckgo.com```