Skip to content

Commit 4eea6e8

Browse files
committed
Update README
1 parent 6a0082c commit 4eea6e8

File tree

1 file changed

+104
-4
lines changed

1 file changed

+104
-4
lines changed

README.md

Lines changed: 104 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,88 @@ Techniques and tools used:
1111
Repo organization:
1212

1313
```
14-
├── unit_testing
15-
│   ├── code_coverage
16-
│   └── test_coverage_reports
17-
└── zephyr
14+
.
15+
├── README.md
16+
├── patches
17+
│ └── bt_crypto.patch
18+
├── testing
19+
│ ├── integration
20+
│ │ └── bt_crypto
21+
│ └── unit
22+
│ ├── bt_encrypt_decrypt
23+
│ └── run_unit_tests.sh
24+
└── zephyr @ 419dda3ed72
25+
.
26+
.
27+
.
28+
├── samples
29+
│ ├── application_development
30+
│ ├── arch
31+
│ ├── basic
32+
│ ├── bluetooth
33+
│ ├── boards
34+
│ ├── classic.rst
35+
│ ├── compression
36+
│ ├── cpp
37+
│ ├── drivers
38+
│ ├── hello_world
39+
│ ├── index.rst
40+
│ ├── kernel
41+
│ ├── modules
42+
│ ├── net
43+
│ ├── philosophers
44+
│ ├── posix
45+
│ ├── sample_definition_and_criteria.rst
46+
│ ├── sensor
47+
│ ├── shields
48+
│ ├── subsys
49+
│ ├── synchronization
50+
│ ├── tfm_integration
51+
│ └── userspace
52+
.
53+
.
54+
.
55+
├── subsys
56+
│ ├── CMakeLists.txt
57+
│ ├── Kconfig
58+
│ ├── bluetooth
59+
│ .
60+
│ .
61+
│ .
62+
│ └── usb
63+
├── tests
64+
│ ├── application_development
65+
│ ├── arch
66+
│ ├── benchmarks
67+
│ ├── bluetooth
68+
│ ├── boards
69+
│ ├── boot
70+
│ ├── cmake
71+
│ ├── crypto
72+
│ ├── drivers
73+
│ ├── kernel
74+
│ ├── lib
75+
│ ├── misc
76+
│ ├── net
77+
│ ├── posix
78+
│ ├── subsys
79+
│ ├── unit
80+
│ └── ztest
81+
├── version.h.in
82+
├── west.yml
83+
├── zephyr-env.cmd
84+
└── zephyr-env.sh
1885
```
1986

2087
### Initializing zephyr submodule
2188

89+
From the root directory of the project run the following:
90+
91+
```
92+
git submodule init
93+
git submodule update
94+
```
95+
2296
#### Install zephyr tools
2397

2498
Zephyr-project's west tool is used for updating the zephyr repository, building, flashing zephyr apps etc. It can be installed using following commands:
@@ -63,3 +137,29 @@ tar xvf zephyr-sdk-0.16.0_linux-x86_64.tar.xz
63137
cd zephyr-sdk-0.16.0
64138
./setup.sh
65139
```
140+
141+
### Initialize zephyr
142+
143+
From the root project directory run the following in order to initialize zephyr build system
144+
145+
`west init -l ./zephyr`
146+
147+
`west update`
148+
149+
### System configuration
150+
151+
Since some of the targets require 32bit libraries, there are some additional system setup needed.
152+
153+
#### Install 32 bit libraries for building on 64bit system
154+
155+
`sudo apt-get install gcc-multilib g++-multilib`
156+
157+
#### Install 32 bit libraries for Valgrind
158+
159+
`sudo apt-get install libc6-dbg libc6-dbg:i386`
160+
161+
#### Install ASAN
162+
163+
`sudo apt-get install libasan6`
164+
165+
Compiler used for the project is `gcc-9` on `wsl` version of `Ubuntu22.04`.

0 commit comments

Comments
 (0)