From: Jason Ryan Date: Fri, 22 May 2015 21:50:45 +0000 (+1200) Subject: Grammar and formatting cleanup in README X-Git-Url: https://git.owens.tech/git.owens.tech/git.owens.tech/git?a=commitdiff_plain;h=129dde0ed79da86b2fe48ffdd3f768fd9354bed7;p=vimb.git Grammar and formatting cleanup in README --- diff --git a/README.md b/README.md index 1a7fcfc..12c32ee 100644 --- a/README.md +++ b/README.md @@ -1,39 +1,39 @@ -# vimb - the vim like browser +# Vimb - the Vim-like browser -Vimb is vim like webbrowser that is inspired by pentadactyl and vimprobable. +Vimb is a Vim-like web browser that is inspired by Pentadactyl and Vimprobable. The goal of Vimb is to build a completely keyboard-driven, efficient and -pleasurable browsing-experience with low memory and cpu usage that is -intuitive to use for vim users. +pleasurable browsing-experience with low memory and CPU usage that is +intuitive to use for Vim users. -More information and some screenshots of vimb browser in action can be found on -the project page of [vimb][]. +More information and some screenshots of Vimb browser in action can be found on +the project page of [Vimb][]. -## features +## Features -- it's modal like vim -- vim like [keybindings][] - assignable for each browser mode -- nearly every configuration can be changed on runtime with vim like [set syntax][set] -- [history][] for ex commands, search queries, urls -- completions for, commands, urls, bookmarked urls, variable names of settings, search-queries +- it's modal like Vim +- Vim like [keybindings][] - assignable for each browser mode +- nearly every configuration can be changed at runtime with Vim like [set syntax][set] +- [history][] for `ex` commands, search queries, URLs +- completions for: commands, URLs, bookmarked URLs, variable names of settings, search-queries - [hinting][hints] - marks links, form fields and other clickable elements to be clicked, opened or inspected -- ssl validation against ca-certificate file +- SSL validation against ca-certificate file - HTTP Strict Transport Security (HSTS) - open input or textarea with configurable external editor - user defined URL-shortcuts with placeholders - custom [protocol handlers][handlers] - read it later [queue][] to collect URIs for later use - multiple yank/paste [registers][] -- vim like [autocmd][] +- Vim like [autocmd][] -## packages +## Packages -- archlinux [vimb-git][arch-git], [vimb][arch] +- Arch Linux [vimb-git][arch-git], [vimb][arch] - [NetBSD][] - [FreeBSD][] - [Void Linux][] -## dependencies +## Dependencies - libwebkit >=1.5.0 - libgtk+-2.0 @@ -42,36 +42,36 @@ the project page of [vimb][]. On Ubuntu these dependencies can be installed by `sudo apt-get install libsoup2.4-dev libwebkit-dev libgtk-3-dev libwebkitgtk-3.0-dev`. -## install +## Install -Edit config.mk to match your local setup. +Edit `config.mk` to match your local setup. -Edit config.h to match your personal preferences. +Edit `config.h` to match your personal preferences. -The default Makefile will not overwrite your customised `config.h` with the +The default `Makefile` will not overwrite your customised `config.h` with the contents of `config.def.h`, even if it was updated in the latest git pull. Therefore, you should always compare your customised `config.h` with `config.def.h` and make sure you include any changes to the latter in your `config.h`. -Run following command to compile and install vimb (if necessary last one as +Run the following commands to compile and install Vimb (if necessary, the last one as root). make clean make // or make GTK=3 to compile against gtk3 make install -To build vimb against gtk3 you can use `make GTK=3`. +To build Vimb against GTK3 you can use `make GTK=3`. -# license +# License -Information about the license are found in the file LICENSE. +Information about the license is found in the file: LICENSE. -# mailing list +# Mailing list - feature requests, issues and patches can be discussed on the [mailing list][mail] -[vimb]: http://fanglingsu.github.io/vimb/ "vimb - vim like browser project page" +[vimb]: http://fanglingsu.github.io/vimb/ "Vimb - Vim like browser project page" [keybindings]: http://fanglingsu.github.io/vimb/keybindings.html "vimb keybindings" [hints]: http://fanglingsu.github.io/vimb/keybindings.html#hinting "vimb hinting" [queue]: http://fanglingsu.github.io/vimb/commands.html#queue "vimb read it later queue feature" @@ -80,9 +80,9 @@ Information about the license are found in the file LICENSE. [registers]: http://fanglingsu.github.io/vimb/keybindings.html#registers "vimb yank/paste registers" [mail]: https://lists.sourceforge.net/lists/listinfo/vimb-users "vimb - mailing list" [NetBSD]: http://pkgsrc.se/wip/vimb "vimb - NetBSD package" -[autocmd]: http://fanglingsu.github.io/vimb/commands.html#autocmd "vim like autocmd and augroup feature" -[set]: http://fanglingsu.github.io/vimb/commands.html#settings "vim like set syntax" -[arch-git]: https://aur.archlinux.org/packages/vimb-git/ "vimb - archlinux package" -[arch]: https://aur.archlinux.org/packages/vimb/ "vimb - archlinux package" +[autocmd]: http://fanglingsu.github.io/vimb/commands.html#autocmd "Vim like autocmd and augroup feature" +[set]: http://fanglingsu.github.io/vimb/commands.html#settings "Vim like set syntax" +[Arch-git]: https://aur.archlinux.org/packages/vimb-git/ "vimb - archlinux package" +[Arch]: https://aur.archlinux.org/packages/vimb/ "vimb - archlinux package" [FreeBSD]: http://www.freshports.org/www/vimb/ "vimb - FreeBSD port" [Void Linux]: https://github.com/voidlinux/void-packages/blob/master/srcpkgs/vimb/template "vimb - Void Linux package"