doc: add page about creating an application #4477
Conversation
|
Or maybe @kaspar030 want's to review? |
| [TOC] | ||
|
|
||
| To create your own application you need to create a directory contating some | ||
| from the C file(s) containing your source code and a Makefile. A template |
There was a problem hiding this comment.
"... some of ...", but I'd drop that and just write "you need to create a directory contating the C file(s) containing your source code and a Makefile"
Also "s/contaiting/containing".
|
I'm on arch, so I cannot test doxygen. Text looks fine! |
|
In pure markdown should work. The bug only is apparent with block-comments: vs |
|
Addressed comments. |
|
Addressed comments |
| that you may want to use `$(CURDIR)` here, to give a relative path) | ||
|
|
||
| The `BOARD` macro is also required and recommended to be set to `native` per | ||
| default, but is recommended to be overridable with the `?=` operator. |
There was a problem hiding this comment.
nitpick: I think “by default” reads more smoothly :D
|
Just plopping by to say I think this is awesome. <3 |
| ================= | ||
| After the board is initialized, RIOT starts two threads: the idle thread and | ||
| the main thread. The idle thread has the lowest priority and will run whenever | ||
| no other thread is ready to run. It will automatically use the lowest possible |
There was a problem hiding this comment.
Well, that's the plan but not really the fact I guess :/
There was a problem hiding this comment.
"Documentation is also specification, not just fact stating" I counter to that ^^
|
Again: Thanks Martine for taking the initiative :-) ! |
| ========================== | ||
| The minimal Makefile {#the-minimal-makefile} | ||
| -------------------- | ||
| At minimum the Makefile of an application (see @ref getting-started) needs to |
There was a problem hiding this comment.
Needs to "define" the macros, right?
|
Besides the minor comments: I like the your documentation enhancement |
|
Addressed comments |
|
Well, ACK (when squashed) from my side. @kaspar030 might also want to check and push the merge button then |
cc37665 to
31702f3
Compare
|
Squashed |
|
Static tests pass, other stuff is not touched => go. |
doc: add page about creating an application
Another one in #4309 bites the dust ;-)