blob: ab7496d0e33dd1283fc05adb34fb237c77035e4f (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
|
# vimb - the vim like browser
This is the development branch for the new webkit2 port of vimb. This branch
does not work and lags a lot of features of the webkit1 version of vimb. So
this is only meant to be the playground for the developers at the moment.
If you like to have a working vimb, please use the master branch.
## Patching and Coding style
### File Layout
- Comment with LICENSE and possibly short explanation of file/tool
- Headers
- Macros
- Types
- Function declarations
- Include variable names
- For short files these can be left out
- Group/order in logical manner
- Global variables
- Function definitions in same order as declarations
- main
### C Features
- Do not mix declarations and code
- Do not use for loop initial declarations
- Use `/* */` for comments, not `//`
### Headers
- Place system/libc headers first in alphabetical order
- If headers must be included in a specific order comment to explain
- Place local headers after an empty line
### Variables
- Global variables not used outside translation unit should be declared static
- In declaration of pointers the `*` is adjacent to variable name, not type
### Indentation
- the code is indented by 4 spaces - if you use vim to code you can set
`:set expandtab ts=4 sts=4 sw=4`
- it's a good advice to orientate on the already available code
- if you are using `indent`, following options describe best the code style
- `--k-and-r-style`
- `--case-indentation4`
- `--dont-break-function-decl-args`
- `--dont-break-procedure-type`
- `--dont-line-up-parentheses`
- `--no-tabs`
## directories
├── doc documentation like manual page
└── src all sources to build vimb
├── scripts JavaScripts that are compiled in for various purposes
└── webextension Source files for the webextension
## dependencies
- webkit2gtk-4.0 >= 2.3.5
## compile and run
To inform vimb during compile time where the webextension should be loaded
from, the `RUNPREFIX` option can be set to a full qualified path to the
directory where the extension should be stored in.
To run vimb without installation you could run as a sandbox like this
make runsandbox
This will compile and install vimb into the local _sandbox_ folder in the
project directory.
# license
Information about the license are found in the file LICENSE.
|
