Skip to content

Commit 741f027

Browse files
tenbahttenbaht
committed
using mkdocs for building the project website
1 parent ab011f1 commit 741f027

21 files changed

Lines changed: 554 additions & 249 deletions

‎.gitignore‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,3 +24,7 @@ build-*
2424
# ignore files generated by patch:
2525
*.orig
2626
*.rej
27+
# ignore mkdocs build directory
28+
site/
29+
# ignore my scratch directory
30+
notes/

‎CHANGELOG.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
77
## [Unreleased]
88
### Added
99
### Changed
10+
- using mkdocs for building the project website
1011
### Fixed
1112

1213
## [0.2.0 - 2017-03-01]

‎README.md‎

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,14 @@ This project is not supposed to be “better than Arduino”. It’s purpose
1414
is to give you a head start into a different CPU architecture if you happen
1515
to have a professional need or a private desire for it.
1616

17-
Please find more detailed information about the supported boards, the needed tools
18-
and the library APIs on the
19-
[project documentation files](https://github.com/tenbaht/sduino/blob/master/docs/index.md).
17+
Please find more detailed information about the supported boards, the needed
18+
tools and the library APIs on the
19+
[project website](https://tenbaht.github.io/sduino/).
2020

2121

2222
## Table of Contents
2323

24-
* [Project Website](blob/master/docs/index.md)
24+
* [Project Website](https://tenbaht.github.io/sduino/)
2525
* [Usage example](#usage)
2626
* [Supported hardware](#supported-hardware)
2727
* [Why use a STM8 instead of an ATmega?](#why-use-a-stm8-instead-of-an-atmega)
@@ -90,8 +90,8 @@ Done! Your first STM8 based project is up and running!
9090
## Supported hardware
9191

9292
Anything with an STM8S103 or STM8S003 should work. For example, the
93-
70-cent-[STM8S103 breakout boards](blob/master/docs/hardware/stm8blue.md),
94-
[ESP14 Wifi boards](blob/master/docs/hardware/esp14.md),
93+
70-cent-[STM8S103 breakout boards](https://tenbaht.github.io/sduino/hardware/stm8blue.md),
94+
[ESP14 Wifi boards](https://tenbaht.github.io/sduino/hardware/esp14.md),
9595
or even the [W1209 thermostat boards](https://www.aliexpress.com/wholesale?SearchText=w1209)
9696
that are abundant on aliexpress and Amazon. All you need to get started is a
9797
simple ST-Link/V2 compatible flash programmer, available for less then $3
@@ -109,12 +109,12 @@ five 10 bit ADC inputs, 3 timers, and up to 14 I/O pins - quite similar to
109109
an Atmel ATmega8 as it was used on the first Arduino boards.
110110

111111
Support for the more powerful
112-
[STM8S105 Discovery board](blob/master/docs/hardware/stm8disco.md)
112+
[STM8S105 Discovery board](https://tenbaht.github.io/sduino/hardware/stm8sdiscovery.md)
113113
is very fresh, but should work now. At least Blink.c works already. These
114114
amazing $9 boards offer even more resources, come with a build-in flash
115115
programmer and are very similar to an Arduino Uno with an ATmega328 CPU.
116116

117-
Find more information here: [Supported Boards](blob/master/docs/hardware.md)
117+
Find more information here: [Supported Boards](https://tenbaht.github.io/sduino/hardware.md)
118118

119119

120120

@@ -193,6 +193,3 @@ processing C++ source files. I am not sure if it would be even possible to
193193
configure a build process based only on C files without modifing the IDE
194194
sources. This makes a full IDE integration very unlikely.
195195

196-
197-
198-

‎_config.yml‎

Lines changed: 0 additions & 5 deletions
This file was deleted.

‎docs/_config.yml‎

Lines changed: 0 additions & 7 deletions
This file was deleted.

‎docs/about.md‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# About
2+
3+
The idea is to smoothen the path towards your first successful STM8-based
4+
project.
5+
6+
The Arduino project was very successful in offering a simplified API hiding
7+
most of the complexity of embedded system programming while still allowing
8+
for advanced programming technics.
9+
10+
The SPL (standard peripheral library) [offered by
11+
ST](http://www.st.com/en/embedded-software/stsw-stm8069.html) is very
12+
powerful and provides an relativly easy migration path towards the STM32 CPU
13+
series in case a project outgrows the capabilities of the 8-bit STM8 series.
14+
But using that library is not very intuitive and still requires a fairly
15+
detailed knowledge of the CPU internals. [compiling the SPL with
16+
SDCC](spl.md)
17+
18+
19+
20+
## Project origin
21+
22+
For a customer I needed to port an existing project from an ATmega to a
23+
better suited (read: cheaper) platform. As the project was based on some
24+
Arduino libraries, porting parts of the Arduino environment was the logical
25+
first step. After doing that porting the firmware was finished in a couple
26+
of days. Porting some of the more commonly used Arduino libraries was a fun
27+
project done in my spare time later.
28+
29+
30+
## About me
31+
32+
I am a freelance programmer for embedded systems and electronics developer
33+
based in Heidelberg, Germany. I work with embedded systems for more than
34+
25 years now.
35+
36+
37+
### Experiences
38+
39+
**current CPU architectures**: AVR (ATmega, ATxmega), PIC, STM8, STM32, MCS51
40+
41+
**classic CPU architectures**: 6502, 68HC11, 6809, Z80, MCS48
42+
43+
**electronics development**: optical sensors, laser driver, sensor
44+
electronics, measurement equipment, industrial control, SMPS, displays
45+
(LCD, TFT)

‎docs/api/HardwareSerial.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# HardwareSerial
2+
3+
Uses the UART. API similar to Arduino. Single instance only.
4+
Pre-instanciated.
5+
6+
This page is only a stub.
7+
8+
9+
## API
10+
## Example
11+
## Implementation details
12+
## Possible impovements

‎docs/api/I2C.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# I2C
2+
3+
The
4+
[I2C master library](http://www.dsscircuits.com/articles/arduino-i2c-master-library)
5+
by Wayne Truchsess offers some significant advantages over the Wire/TWI
6+
library included in the standard arduino environment: It fixes some possible
7+
deadlock situations, it allows for communication using a repeated start
8+
condition as required by some devices, the code is much more compact and the
9+
structure is easier to understand.
10+
11+
The current state of the port does not include the deadlock protection,
12+
though.

‎docs/api/LiquidCrystal.md‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -119,6 +119,3 @@ assume 4-bit mode.
119119

120120
As init() is not called very frequently the possible advantage would be small
121121
compared to the downside of breaking the Arduino compatibility.
122-
123-
124-
[Back to the main page](../index.html)

‎docs/api/Mini_SSD1306.md‎

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -125,8 +125,3 @@ Other libraries:
125125
Faster I2C transfer is supported by the [I2C.html](I2C library), but to use
126126
it you have to modify the source code for the Mini_SSD1306 library. Make
127127
this configurable in the instantiation function.
128-
129-
130-
131-
132-
[Back to the main page](../index.html)

0 commit comments

Comments
 (0)