You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Dec 6, 2018. It is now read-only.
[](https://gitter.im/forGGe/theCore?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
@@ -10,7 +10,7 @@ The main idea of theCore is to make as much as possible in the compile time.
10
10
This affects the way how the device drivers and peripherals are represented.
11
11
In fact, each driver is the template class that is instantiated with all the dependencies in a distinct type by user of theCore in the compile time.
12
12
13
-
You can check out more directly in the code of [the SPI driver](platform/stm32/export/aux/spi_bus.hpp) or [the USART bus](platform/stm32/export/aux/usart_bus.hpp).
13
+
You can check out more directly in the code of [the SPI driver](https://github.com/forGGe/theCore/blob/master/platform/stm32/export/aux/spi_bus.hpp) or [the USART bus](https://github.com/forGGe/theCore/blob/master/platform/stm32/export/aux/usart_bus.hpp).
14
14
15
15
The project is at the initial stage. But something is already in there:
16
16
- CMake-based build-system
@@ -26,11 +26,14 @@ The project is at the initial stage. But something is already in there:
26
26
27
27
If you are interested in the simplest, ready-made demo project based on theCore, refer to [the blinky example project](https://github.com/forGGe/theCore-blinky).
28
28
29
-
You may also check [examples within theCore source tree](examples/).
29
+
You may also check [examples within theCore source tree](https://github.com/forGGe/theCore/tree/master/examples).
30
30
31
31
In order to proceed with theCore itself, start cloning this repository:
32
32
```
33
33
git clone https://github.com/forGGe/theCore.git
34
+
cd theCore
35
+
git checkout master # Stable branch
36
+
git submodule update --init --recursive
34
37
```
35
38
36
39
When the code is received, you have to download and install all the dependencies.
@@ -46,9 +49,9 @@ nix-shell --pure
46
49
47
50
## Examples
48
51
49
-
Examples reside in the [`examples`](examples) dir. Each example contains instructions how to compile and use the example.
52
+
Examples reside in the [`examples`](https://github.com/forGGe/theCore/tree/master/examples) dir. Each example contains instructions how to compile and use the example.
50
53
51
-
To build all examples at once you can use nix and specially crafted [superproject](examples/CMakeLists.txt).
54
+
To build all examples at once you can use nix and specially crafted [superproject](https://github.com/forGGe/theCore/tree/master/examples/CMakeLists.txt).
52
55
To do that, [enter the nix shell](#getting-started) and proceed as follows.
53
56
54
57
```bash
@@ -60,8 +63,8 @@ make
60
63
```
61
64
62
65
Resulting binaries will be placed under corresponding directories.
63
-
I.e. the [cs43l22 example](examples/cs43l22_audio) if built that way, will be placed under `build/stm32f4_cs43l22_audio-prefix/src/stm32f4_cs43l22_audio-build/` directory.
64
-
You can refer to the [external project CMake documetation](https://cmake.org/cmake/help/v3.4/module/ExternalProject.html) and [the superproject CMake list file](examples/CMakeLists.txt) to figure out where binaries will be placed.
66
+
I.e. the [cs43l22 example](https://github.com/forGGe/theCore/tree/master/examples/cs43l22_audio) if built that way, will be placed under `build/stm32f4_cs43l22_audio-prefix/src/stm32f4_cs43l22_audio-build/` directory.
67
+
You can refer to the [external project CMake documetation](https://cmake.org/cmake/help/v3.4/module/ExternalProject.html) and [the superproject CMake list file](https://github.com/forGGe/theCore/tree/master/examples/CMakeLists.txt) to figure out where binaries will be placed.
65
68
Instructions describing how to flash binary onto the device placed in the readme file inside each example.
66
69
67
70
## Unit tests
@@ -86,7 +89,7 @@ ctest . --output-on-failure
86
89
## On-device tests
87
90
88
91
theCore comes with tests that can be executed on the device itself.
89
-
Refer to [the theCore testing documentation](tests/README.md) to figure out how to build, use and manage on-device theCore tests.
92
+
Refer to [the theCore testing documentation](https://github.com/forGGe/theCore/tree/master/tests/README.md) to figure out how to build, use and manage on-device theCore tests.
90
93
To build all tests, [enter the nix shell](#getting-started) and proceed as follows:
91
94
92
95
```bash
@@ -101,10 +104,10 @@ make
101
104
102
105
| Short name | Full name | List of supported MCUs | Path in project |
@@ -128,7 +131,7 @@ The project is on its very beginning, so any help is more than welcome and highl
128
131
If you'd like to take a part in the project growth and (or) have any questions – feel free to email me at [email protected], leave message at [gitter](https://gitter.im/forGGe/theCore) or simply check out [a list of issues](https://github.com/forGGe/theCore/issues).
129
132
If you have any suggestions on theCore improvement or just like it how it is, don’t keep silence! I’ll be happy to read your reviews.
130
133
131
-
When making pull requests, make sure that code conforms to [theCore code style guide](style.md).
134
+
When making pull requests, make sure that code conforms to [theCore code style guide](https://github.com/forGGe/theCore/tree/master/style.md).
132
135
133
136
You are welcome to use theCore in your own projects.
134
137
If there is something that it’s not enough for this, please let me know via email or open some issues and we will do our best to handle this ASAP.
0 commit comments