Skip to content

Commit bd95ae3

Browse files
committed
Replace tinyhal subtree with submodule
1 parent 227bc2f commit bd95ae3

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

64 files changed

+47
-5083
lines changed

.gitmodules

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
[submodule "deps/tinyhal"]
2+
path = deps/tinyhal
3+
url = https://github.com/lexus2k/tinyhal

README.md

+40
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,10 @@ I2C or any other communication channels.
2525
Tiny SLIP protocol is based on RFC 1055.
2626
This protocol doesn't implement any error detection.
2727

28+
## Dependencies
29+
30+
* [tinyhal](https://github.com/lexus2k/tinyhal)
31+
2832
## Key Features
2933

3034
Main features:
@@ -57,6 +61,19 @@ SLIP::Packet<256> packet;
5761
## How to build
5862
5963
### Linux
64+
65+
1. Getting source code
66+
67+
If you wish to build the library with all dependencies you need to clone project using command
68+
```.txt
69+
git clone --recursive https://github.com/lexus2k/tinyslip
70+
```
71+
If you have all dependencies installed in the system, use the following command for cloning
72+
```.txt
73+
git clone https://github.com/lexus2k/tinyslip
74+
```
75+
76+
2. Building
6077
```.txt
6178
make
6279
# === OR ===
@@ -67,12 +84,35 @@ make
6784
```
6885

6986
### Windows
87+
88+
1. Getting source code
89+
90+
If you wish to build the library with all dependencies you need to clone project using command
91+
```.txt
92+
git clone --recursive https://github.com/lexus2k/tinyslip
93+
```
94+
If you have all dependencies installed in the system, use the following command for cloning
95+
```.txt
96+
git clone https://github.com/lexus2k/tinyslip
97+
```
98+
99+
2. Building
70100
```.txt
71101
mkdir build
72102
cd build
73103
cmake -G "Visual Studio 16 2019" -DEXAMPLES=ON ..
74104
```
75105

106+
### ESP32
107+
108+
1. Getting source code
109+
110+
TODO
111+
112+
2. Building
113+
114+
Just build your project as regular ESP32 IDF project.
115+
76116
## Setting up
77117

78118
* Arduino Option 1 (with docs and tools)

deps/tinyhal

Submodule tinyhal added at ee74320

deps/tinyhal/.codedocs

-193
This file was deleted.

deps/tinyhal/.gitignore

-52
This file was deleted.

deps/tinyhal/.travis.yml

-47
This file was deleted.

deps/tinyhal/.travis/check_install.sh

-22
This file was deleted.

0 commit comments

Comments
 (0)