blob: fb8d09277693131fad9f612bcb780c5a131e439f (
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
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
|
# Overview
libWeave is the library with device side implementation of Weave protocol.
# Sources
Sources are located in git repository at
https://weave.googlesource.com/weave/libweave/
# Install Repo
Make sure you have a bin/ directory in your home directory
and that it is included in your path:
```
mkdir ~/bin
PATH=~/bin:$PATH
```
Download the Repo tool and ensure that it is executable:
```
curl https://storage.googleapis.com/git-repo-downloads/repo > ~/bin/repo
chmod a+x ~/bin/repo
```
# Checkout code
```
repo init -u https://weave.googlesource.com/weave/manifest
repo sync
```
# Directory structure
| Path | Description |
|--------------------------|------------------------------------|
| include/ | Includes to be used by device code |
| src/ | Implementation sources |
| examples/ | Example of device code |
| third_party/ | Dependencies |
| Makefile, \*.mk files | Build files |
# Quick start on Debian/Ubuntu
### Install prerequisites
```
sudo apt-get update
sudo apt-get install \
autoconf \
automake \
binutils \
g++ \
hostapd \
libavahi-client-dev \
libcurl4-openssl-dev \
libevent-dev \
libexpat1-dev \
libnl-3-dev \
libnl-route-3-dev \
libssl-dev \
libtool
```
# Prerequisites
### Common
- autoconf
- automake
- binutils
- libtool
- libexpat1-dev
### For tests
- cmake
- gtest (included; see third_party/get_gtest.sh)
- gmock (included; see third_party/get_gtest.sh)
### For examples
- cmake
- hostapd
- libavahi-client-dev
- libcurl4-openssl-dev
- libevhtp (included; see third_party/get_libevhtp.sh)
- libevent-dev
# Compiling
The `make --jobs/-j` flag is encouraged, to speed up build time. For example
```
make -j
```
which happens to be the same as
```
make all -j
````
### Build library
```
make out/Debug/libweave.so
```
### Build examples
```
make all-examples
```
See [the examples README](/examples/daemon/README.md) for details.
# Testing
### Run tests
```
make test
make export-test
```
or
```
make testall
```
# Making changes
### Configure git
Make sure to have correct user in local or global config e.g.:
```
git config --local user.name "User Name"
git config --local user.email user.name@example.com
```
### Start local branch
```
repo start <branch name> .
```
### Edit code and commit locally e.g.
```
git commit -a -v
```
### Upload CL
```
repo upload .
```
### Request code review
Go to the url from the output of "repo upload" and add reviewers.
|
