Skip to content

Commit 6236510

Browse files
committed
forgot to update some documentation and the README
1 parent 1db470f commit 6236510

3 files changed

Lines changed: 25 additions & 8 deletions

File tree

CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,16 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/)
55
and this project adheres to [Semantic Versioning](http://semver.org/).
66

77
## [Unreleased]
8+
9+
10+
## [0.4.0 - 2018-12-07]
811
### Added
912
- using stm8gal to upload using the builtin bootloader of larger STM8 devices
1013
- Support for STM8S105K4 breakout board (stm8sblack)
1114
- Support for Sduino-UNO board (s8uno)
1215
- Support for Sduino MB board (mb208)
1316
- Unlocking a MCU by using Tools->Burn Bootloader in the Arduino IDE
17+
- new library LiquidCrystal_I2C for text LCD with I2C converter backpack
1418
- new library LiquidCrystal_pcf2119 for I2C text LCD based on the PCF2119
1519
- new library Wire for I2C communication
1620
- new library EEPROM

README.md

Lines changed: 20 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -53,10 +53,16 @@ Now you should find a new entry *STM8S Boards* in the list at
5353

5454
## Known issues
5555

56-
The Arduino IDE Version 1.8.7 suffers from a known regression bug. If you
57-
see the error message "select upload port first" apply this
56+
**select upload port first**: The Arduino IDE version 1.8.7 suffers from a
57+
known regression bug. If you see this error message update to Arduino IDE
58+
version 1.8.8 or apply this
5859
[workaround](https://github.com/tenbaht/sduino/issues/68#issuecomment-441425529).
5960

61+
**bash.exe: warning: could not find /tmp, please create!**: Shows up on windows
62+
systems. Annoying, but harmless.
63+
[Workaround](https://github.com/tenbaht/sduino/issues/61#issuecomment-443551180)
64+
65+
6066

6167
## Included libraries
6268

@@ -69,24 +75,31 @@ guide](https://tenbaht.github.io/sduino/api/migration/) for details.
6975
#### Communication
7076

7177
* SPI: Real hardware-SPI up to 10MHz.
78+
* Wire: Port of the stock Wire library for I2C communication (with
79+
improvements)
7280
* I2C: Port of the I2C master library by Wayne Truchsess
7381
* HardwareSerial: The standard serial interface.
7482

7583
#### Displays
7684

7785
* LiquidCrystal: HD44780 based text LCDs
86+
* LiquidCrystal_I2C: HD44780 based text LCDs with I2C converter backpack
87+
* LiquidCrystal_pcf2119: PCF2119 based text LCDs with I2C connection
7888
* PCD8544: Monochrome graphical LCD based on the PCD8544 controller like the
7989
Nokia 5110 display. SPI mode only.
8090
* Mini_SSD1306: SSD1306-based monochrome OLED displays with 128x64 pixels.
8191
I2C support only.
8292

93+
#### Storage
94+
95+
* EEPROM: Port of the stock EEPROM library for accessing the buildin EEPROM
96+
8397
#### Motor control
8498

8599
* Stepper: Stepper motors with 2, 4 or 5 phases.
86100
* Servo: Up to 12 servos using only 1 timer.
87101

88102

89-
90103
## Compatibility with the Arduino world
91104

92105
Since there is no free C++ for the STM8, it is impossible to do a full 1:1
@@ -104,15 +117,15 @@ guide](https://tenbaht.github.io/sduino/api/migration/) for an overview.
104117

105118
## Supported Systems:
106119

107-
Arduino IDE versions 1.8.7, 1.8.5 and 1.6.13 are tested, but any version >=1.6.6
108-
should work.
120+
Arduino IDE versions 1.8.8, 1.8.7, 1.8.5 and 1.6.13 are tested, but any
121+
version >=1.6.6 should work.
109122

110123
Version 1.8.7 might require a
111124
[workaround](https://github.com/tenbaht/sduino/issues/68#issuecomment-441425529)
112125
if you see an error message "select upload port first".
113126

114-
* Linux 64 bit: Tested on Ubuntu 16.04
115-
* Linux 32 bit: Tested on Ubuntu 16.04
127+
* Linux 64 bit: Tested on Mint 19/Ubuntu 18.04
128+
* Linux 32 bit: Tested on Mint 19/Ubuntu 18.04
116129
* Windows: Tested on Windows 7. Sduino might work on XP (not tested), but
117130
the ST-Link/V2 driver is not available anymore for XP.
118131
* MacOS: tested on 10.13.

board-manager/Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ DATE=$(shell date '+%F')
4646
release:
4747
# update the version number in the changelog if not already done:
4848
grep -q "$(COREVERSION)" ../CHANGELOG.md || \
49-
sed "/^## \[Unreleased\]/ a\\\n\n## [$(COREVERSION) - $(DATE)]" ../CHANGELOG.md
49+
sed -i "/^## \[Unreleased\]/ a\\\n\n## [$(COREVERSION) - $(DATE)]" ../CHANGELOG.md
5050
git add ../CHANGELOG.md ../$(PACKAGEFILE)
5151
git add parts/tools-*-$(SDCCVERSION).txt parts/tools-*-$(TOOLSVERSION).txt parts/platform-*-$(COREVERSION).txt
5252
git commit

0 commit comments

Comments
 (0)