Commit Graph

96 Commits

Author SHA1 Message Date
David O'Connor e9714261c3 Added doc comment to styleguide 2022-03-26 16:11:03 -04:00
Nicolas VERHELST 17fd27e3a6 Add some other back quotes 2022-03-15 17:25:22 +11:00
Nicolas VERHELST f519a089a6 Fix escape 2022-03-15 17:14:22 +11:00
Nicolas VERHELST dcdf5e6af8 Add missing back quotes 2022-03-15 17:10:16 +11:00
Mark Haslinghuis 2947bae4ea Update documentation for building in Ubuntu
Update documentation for building in Ubuntu

last change
2022-01-08 05:02:55 +01:00
Mark Haslinghuis 4c6075b52b Fix Fedora Development Documentation 2021-12-28 01:18:09 +01:00
Chris 7641bdcc91
adds additional headings to Curly braces section
Adds proposed sub headings to Formatting Style > Curly Braces section
2021-01-22 16:01:58 -08:00
Chris 5e5748c99a
removes unintentional heading 2021-01-22 15:58:17 -08:00
Chris 79bfa181dd
Clarifies and clean-up Formatting style > Curly braces
- adds `code` formatting to some keywords
- adds some more clarifications to existing style rules.
2021-01-22 15:51:35 -08:00
Mark Haslinghuis b88f948004 Fixed test build on Fedora and Ubuntu with native clang 2020-10-23 19:52:37 +02:00
Michael Keller fa6c0e2db1
Merge pull request #10255 from haslinghuis/fix-ubuntu-devdoc 2020-10-13 01:36:29 +13:00
Mark Haslinghuis 304ef3002e Update Ubuntu development 2020-10-12 00:32:49 +02:00
haslinghuis 821d99a000 Update Building in Fedora to 32 2020-10-07 03:27:56 +02:00
haslinghuis 5c7939acb8 Ubuntu development documentation updated. 2020-07-08 18:33:36 +02:00
mikeller 103712855c Added instructions for how to add test targets to pull requests. 2020-05-05 00:24:51 +12:00
s-ol 6270c2044f Add build documentation for Arch Linux 2020-01-12 15:42:16 +01:00
Kenneth Mitchell 8cff58c9b2
Update Building in Windows.md
Missing unzip dependency.
2019-11-28 21:21:46 -05:00
deepdigger 06505e4524
Add spaces between "#" and the description
Hi, I'm new to Betaflight developing. Here I found some missing spaces in the headline so I fixed it so the .md file can work.
2019-11-25 14:03:40 +01:00
Kyle Kienapfel f57128e7c1
Update Development.md
From discussion in #8558
2019-07-10 20:48:42 -07:00
swilkens 794f4a93e9
[Docs] Further update Building in Windows
Restructured, further clarified and added the make_sdk_install script option.

I will update the pictures and other references in a future PR
2019-04-18 14:20:48 +02:00
swilkens 921754c2c7
[Docs] Update ARM toolchain version link
The currently listed version (5.4.1) is insufficient, version 7.3.1 (represented as 7-2018-q2-update) is expected in make\tools.mk (GCC_REQUIRED_VERSION ?= 7.3.1)
2019-03-12 20:32:10 +01:00
Michael Keller 10ae62efed
Merge pull request #7312 from mikeller/amend_parentheses_rule
Amended rule to stipulate minimal use of parentheses.
2019-01-12 19:22:55 +13:00
mikeller fda4bd2124 Updated coding style documentation. 2019-01-09 09:13:15 +13:00
mikeller af0a3ad58b Added exception for ternary conditional operator. 2018-12-30 10:15:12 +13:00
J Blackman 68a3daaade
Merge pull request #7311 from mikeller/update_enum_documentation
Added rule for trailing comma in enums.

Agreed.
2018-12-29 16:06:23 -05:00
mikeller 82e999e589 Amended rule to stipulate minimal use of parentheses. 2018-12-30 00:32:26 +13:00
mikeller 3466923dc3 Added rule for trailing comma in enums. 2018-12-30 00:15:06 +13:00
mikeller 3eafbc87ae Updated policy on allowing 'if' without braces. 2018-12-30 00:03:21 +13:00
mikeller 27dd36590b Amended parameter group documentation to include array length considerations. 2018-11-27 23:33:40 +13:00
mikeller e4bd905f70 Added clarification about new parameters if 0 is an invalid value. 2018-11-25 15:51:26 +13:00
mikeller cad702b4f7 Amended parameter group documentation to contain uniformity / atomicity constraints. 2018-11-25 13:40:17 +13:00
Michael Keller 0f296d13d8
Merge pull request #7011 from mikeller/add_parameter_group_doc
Added documentation for dealing with parameter groups.
2018-10-31 02:09:36 +13:00
mikeller efdaf241d8 Added documentation for dealing with parameter groups. 2018-10-31 01:17:13 +13:00
Steffen Windoffer 95cd6fc022 update docs for how to build under osx 2018-10-29 16:37:28 +01:00
Steffen Windoffer 956ea31c8f update switch example to fit current coding style 2018-10-20 15:04:12 +02:00
timman2er b38afdb7db Fix building guide (rebase because weird things happened 2018-09-02 02:54:46 +02:00
timman2er 30daff9643 fix name of software in development.md 2018-08-30 22:37:20 +02:00
Tim Eckel 290cfebd99
Markdown fixes and added style examples 2018-08-28 10:30:55 -04:00
Neil B 97b787fb72 Cleaned up markdown
Added markdown code bash tags and removed whitespace
2018-05-03 20:27:11 -07:00
ileou 31b3959221 Update Building in Ubuntu.md (#5408)
Adjust the ARM_SDK_DIR variable in TOOLS.MK file with the "gcc-arm-none-eabi-xxx" version.
2018-03-15 02:14:33 +13:00
mikeller 6de40c49fc Moved board docs into their own folder. Also fixed file permissions. 2018-01-18 17:55:38 +13:00
Phil Hord 579f6e1de8 Fix markdown links to filenames with spaces
Markdown links cannot have actual spaces in the filename.  Use URL-encoded
spaces (%20) instead.

robo-fixed using:
   sed -i -e 's/\(]([^ )]*\) \([^"]\)/\1%20\2/g' **/*.md

If you don't use zhell, you may need to customize the ** part of that command.
2018-01-08 12:19:35 +13:00
Hydra eb800966d9 CF - restore docs folder from master_v1.x 2018-01-08 12:19:35 +13:00
borisbstyle c8e7850c3d Betaflight Cleanup targets / docs 2016-02-10 23:09:22 +01:00
borisbstyle 05dec6c21e Revert "Remove OpenPilot bootloader support."
This reverts commit 0150abf1bc.

Conflicts:
	src/main/target/CC3D/target.h
2015-10-15 09:59:29 +02:00
Dominic Clifton 0150abf1bc Remove OpenPilot bootloader support.
This can be added back at a later date if required if enough code-size
savings can be found, for instance, the removal of the CLI.
2015-10-12 20:44:51 +01:00
Nicholas Sherlock 79aabff225 Add Blackbox internal log format specification 2015-09-27 20:03:52 +13:00
Dominic Clifton 6a24295525 Merge pull request #1241 from opsidao/patch-1
Update tests invocation in Development.md
2015-09-10 02:14:18 +01:00
David Bieber 6fb181b600 Fix spelling of go to in docs/development/Development.md 2015-09-07 23:15:46 -07:00
David Bieber 5f18ad6d48 Fix spelling of declaration in docs/development/Development.md 2015-09-07 23:13:36 -07:00