File tree Expand file tree Collapse file tree 4 files changed +46
-5
lines changed Expand file tree Collapse file tree 4 files changed +46
-5
lines changed Original file line number Diff line number Diff line change
1
+ ---
2
+ layout : default
3
+ title : API Documentation
4
+ nav_order : 3
5
+ ---
6
+
7
+ # API Documentation
8
+
9
+ The API documentation is generated independently of the rest of this docs and
10
+ can be found here:
11
+ https://microbit-foundation.github.io/microbit-universal-hex/api/
Original file line number Diff line number Diff line change 1
1
---
2
2
layout : page
3
3
title : Contributing
4
- nav_order : 3
4
+ nav_order : 5
5
5
---
6
6
7
7
# Contributing
@@ -17,18 +17,33 @@ nav_order: 3
17
17
18
18
## How To Contribute
19
19
20
- WIP.
20
+ Thanks for looking here! We'd love your help. The micro: bit project is only
21
+ possible through contributions of companies and individuals around the world.
22
+
23
+ This project is managed on GitHub, and the best way to contribute is to jump
24
+ into the GitHub issue tracker to see what is available. Planned features are
25
+ marked with the "enhancement" label, and know issues are marked with the "bug"
26
+ label.
27
+
28
+ https://github.com/microbit-foundation/microbit-universal-hex/issues
29
+
30
+ If you're interested in working on any of these items, please respond to an
31
+ existing issue, or file a new one, and mention @microbit-carlos .
21
32
22
33
## Code Of Conduct
23
34
24
35
WIP.
25
36
26
37
## Bugs
27
38
28
- Issue tracker: https://github.com/microbit-foundation/microbit-fs/issues
39
+ Please report any bugs in the GitHub issue tracker:
40
+ https://github.com/microbit-foundation/microbit-universal-hex/issues
29
41
30
42
## Development Workflow
31
43
44
+ This project follows a fairly standard node.js process:
45
+
32
46
- ` npm install ` to install dependencies
33
47
- ` npm test ` runs the complete test suite
34
- - ` npm build ` create a build with all the output formats
48
+ - ` npm build ` creates a build of the library in all the output formats
49
+ - ` npm docs ` builds the API documentation into the ` docs/api/ ` directory
Original file line number Diff line number Diff line change @@ -10,7 +10,7 @@ nav_order: 1
10
10
11
11
{: .fs-9 }
12
12
13
- <img alt =" microbit-universal-hex logo " src =" img/microbit-uh-logo.png " style =" max-height : 100 px ; float : left ; padding-right : 16px ;" >
13
+ <img alt =" microbit-universal-hex logo " src =" img/microbit-uh-logo.png " style =" max-height : 125 px ; float : left ; padding-right : 16px ;" >
14
14
15
15
Create Universal Hex files for the micro: bit .
16
16
{: .fs-6 .fw-300 }
Original file line number Diff line number Diff line change
1
+ ---
2
+ layout : default
3
+ title : Universal Hex Format
4
+ nav_order : 4
5
+ ---
6
+
7
+ # Universal Hex Format
8
+
9
+ The micro: bit Universal Hex format is a superset of the
10
+ [ Intel Hex file format] ( https://en.wikipedia.org/wiki/Intel_HEX ) designed to be
11
+ able to include data for multiple targets into a single file.
12
+
13
+ This section of the docs is still a Work In Progress. For detailed information
14
+ on the format please visit:
15
+ https://github.com/microbit-foundation/spec-universal-hex
You can’t perform that action at this time.
0 commit comments