Skip to content

doc: add page about creating an application#4477

Merged
miri64 merged 2 commits intoRIOT-OS:masterfrom
miri64:doc/enh/creating-application
Dec 16, 2015
Merged

doc: add page about creating an application#4477
miri64 merged 2 commits intoRIOT-OS:masterfrom
miri64:doc/enh/creating-application

Conversation

@miri64
Copy link
Copy Markdown
Member

@miri64 miri64 commented Dec 14, 2015

Another one in #4309 bites the dust ;-)

@miri64 miri64 added the Area: doc Area: Documentation label Dec 14, 2015
@miri64 miri64 added this to the Release 2015.12 milestone Dec 14, 2015
@OlegHahm OlegHahm mentioned this pull request Dec 14, 2015
24 tasks
@miri64
Copy link
Copy Markdown
Member Author

miri64 commented Dec 14, 2015

Or maybe @kaspar030 want's to review?

@miri64 miri64 assigned kaspar030 and unassigned OlegHahm Dec 14, 2015
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"... 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".

@kaspar030
Copy link
Copy Markdown
Contributor

I'm on arch, so I cannot test doxygen. Text looks fine!

@miri64
Copy link
Copy Markdown
Member Author

miri64 commented Dec 14, 2015

In pure markdown should work. The bug only is apparent with block-comments:

~~~~~~~~
some code
~~~~~~~~

vs

/**
 * ~~~~~~~
 * some code
 * ~~~~~~~
 */

@miri64
Copy link
Copy Markdown
Member Author

miri64 commented Dec 14, 2015

Addressed comments.

@miri64
Copy link
Copy Markdown
Member Author

miri64 commented Dec 14, 2015

Addressed comments

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nitpick: I think “by default” reads more smoothly :D

@Lotterleben
Copy link
Copy Markdown
Member

Just plopping by to say I think this is awesome. <3

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well, that's the plan but not really the fact I guess :/

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Documentation is also specification, not just fact stating" I counter to that ^^

@PeterKietzmann
Copy link
Copy Markdown
Member

Again: Thanks Martine for taking the initiative :-) !

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Needs to "define" the macros, right?

@PeterKietzmann
Copy link
Copy Markdown
Member

Besides the minor comments: I like the your documentation enhancement

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Area: doc Area: Documentation CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants