Skip to content

Commit 15ca396

Browse files
Tweak doc index.md
1 parent 3c1a610 commit 15ca396

File tree

1 file changed

+16
-14
lines changed

1 file changed

+16
-14
lines changed

docs/index.md

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,18 @@ nav_order: 1
1010

1111
<img alt="microbit-universal-hex logo" src="img/microbit-uh-logo.png" width="300px">
1212

13+
## Introduction
14+
1315
Create Universal Hex files for the micro:bit.
1416

1517
This is the documentation for the micro:bit Universal Hex library.
1618

1719
Here you will find the available public API to convert Intel Hex strings into Universal Hex strings and vice-versa.
1820

21+
## Getting started
22+
23+
Read the [Quick guide](quick-guide.md).
24+
1925
## Universal Hex format
2026

2127
The micro:bit Universal Hex format is a superset of the
@@ -28,28 +34,24 @@ Detailed information of the Universal Hex format can be found in the [specificat
2834
This TypeScript/JavaScript library can be used to create a
2935
micro:bit Universal Hex from two or more micro:bit Intel Hex files.
3036

31-
## Online tool
37+
## Web tool
3238

33-
An implementation example can be found in the [webtool.html](./examples/webtool.html)
34-
in the repository and it is hosted in the
35-
[micro:bit Tech Site](ttps://tech.microbit.org).
39+
This [Universal Hex Creator web tool](https://tech.microbit.org/software/universal-hex-creator/) can
40+
generate a Universal Hex from two Intel Hex files (one for micro:bit V1 and another for micro:bit V2).
3641

37-
This web tool can generate a Universal Hex from an Intel Hex file for micro:bit
38-
V1 and an Intel Hex file for micro:bit V2.
42+
An implementation example can be found in the [webtool.html](https://github.com/microbit-foundation/microbit-universal-hex/blob/main/docs/examples/webtool.html) file, which produces this [Universal Hex Creator demo](./examples/webtool.html).
3943

40-
- [Universal Hex Creator](https://tech.microbit.org/software/universal-hex-creator/)
41-
- [Universal Hex Separator](https://microbit-foundation.github.io/microbit-universal-hex/examples/separate.html)
44+
An implementation example showing the reverse process of separating a Universal Hex into individual Intel Hex files can be found in the [seperate.html](https://github.com/microbit-foundation/microbit-universal-hex/blob/main/docs/examples/separate.html) file. It produces this [Universal Hex Separator demo](./examples/separate.html).
4245

4346
## Related documentation
4447

45-
[micro:bit Universal Hex Specification](https://github.com/microbit-foundation/spec-universal-hex) contains a lot more information
46-
about the file data format.
48+
- [micro:bit Universal Hex Specification](https://github.com/microbit-foundation/spec-universal-hex) contains a lot more information
49+
about the file data format.
4750

48-
[GitHub](https://microbit-foundation.github.io/microbit-universal-hex/) contains general documentation for this
49-
library.
51+
- [GitHub](https://microbit-foundation.github.io/microbit-universal-hex/) contains general documentation for this
52+
library.
5053

51-
[The micro:bit Tech Site](https://tech.microbit.org) contains general technical information about the
52-
micro:bit.
54+
- [The micro:bit Tech Site](https://tech.microbit.org) contains general technical information about the micro:bit.
5355

5456
## License
5557

0 commit comments

Comments
 (0)