Update and rename readme to readme.md

This commit is contained in:
fenze 2022-05-14 15:07:37 +02:00 committed by GitHub
parent 2d1f4dfdac
commit 8567b0943c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 31 additions and 35 deletions

35
readme
View File

@ -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

31
readme.md Normal file
View File

@ -0,0 +1,31 @@
<h1 align="center">Rose Browser</h1>
<p align="center">Simple browser based on webkit2-5.0/GTK4.</p>
## Showcase
<img src="https://github.com/mini-rose/rose/blob/master/screenshots/homepage.png?raw=true">
<img src="https://github.com/mini-rose/rose/blob/master/screenshots/youtube.png?raw=true">
## 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```