CopterExpress/clover
1
0
Fork 0
mirror of https://github.com/CopterExpress/clover.git synced 2026-05-26 21:19:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: add more proper names to markdownlint

Browse Source
This commit is contained in:
Oleg Kalachev
2019-07-30 18:03:42 +03:00
parent b25a58c047
commit f5da6bc11c
7 changed files with 44 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
.markdownlint.json
View File

@@ -13,17 +13,32 @@
"MD040": false,
"MD044": {
"names": [
"COEX",
"Copter Express",
"Коптер Экспресс",
"Клевер",
"MAVLink",
"ROS",
"ROS Kinetic",
"OpenCV",
"Gazebo",
"GitHub",
"FPV",
"PPM",
"PWM",
"Python",
"C++",
"JavaScript",
"Node.js",
"Django",
"Flask",
"HTTP",
"HTTPS",
"WebSocket",
"RPC",
"PX4",
"ArduPilot",
"jMAVSim",
"px4.io",
"logs.px4.io",
"QGroundControl",
@@ -31,16 +46,23 @@
"WireShark",
"FlightPlot",
"OFFBOARD",
"ACRO",
"RPY",
"LPE",
"EKF2",
"IMU",
"VPE",
"SITL",
"PID",
"Wi-Fi",
"Raspberry Pi",
"RPi",
"Linux",
"GNU",
"GNU/Linux",
"Windows",
"Docker",
"RFC",
"Travis",
"travis-ci.org",
"travis-ci.com",
@@ -51,6 +73,7 @@
"Raspbian",
"Raspbian Jesse",
"Raspbian Stretch",
"Raspbian Buster",
"Pixhawk",
"Pixracer",
"Arduino",
@@ -59,12 +82,19 @@
"LIRC",
"GPIO",
"HC-SR04",
"RCW-0001",
"RealSense",
"NUC",
"NVIDIA",
"Jetson",
"Jetson Nano",
"STM",
"LED",
"USB",
"FAT32",
"uORB",
"SSH",
"PuTTY",
"API",
"UART",
"GND",

4
docs/en/gloss.md
View File

@@ -11,7 +11,7 @@ An unmanned aerial vehicle with an electronic stabilization system and the numbe
## Flight controller / autopilot
**1\.** A specialized circuit-board designed for controlling a multicopter, an aircraft or another apparatus. Examples:
Pixhawk, Ardupilot, Naze32, CC3D.
Pixhawk, ArduPilot, Naze32, CC3D.
**2\.** Software for the multicopter control circuit-board. Examples: PX4, APM, CleanFlight.
@@ -41,7 +41,7 @@ Clever may also be [controlled from a smartphone](rc.md).
## Arming
Armed is the state of copter readiness for the fligh. When the gas stick is lifted, or when an external command with the target point is sent, the copter will fly. Usually, a copter starts rotating its propellers when it is switched to the "armed" state, even if the gas stick is down.
Armed is the state of copter readiness for the flight. When the gas stick is lifted, or when an external command with the target point is sent, the copter will fly. Usually, a copter starts rotating its propellers when it is switched to the "armed" state, even if the gas stick is down.
The opposite state is Disarmed.

4
docs/en/human_pose_estimation_drone_control.md
View File

@@ -62,7 +62,7 @@ chmod +x .to_client.bash
./.to_client <NAME_OF_NETWORK> <PASSWORD>
```
- Install the tornado library to make a websocket server
- Install the tornado library to make a WebSocket server
```sh
sudo pip install tornado
@@ -101,7 +101,7 @@ python main_drone.py
python main_drone.py
```
- Run Human pose estimation module on your laptop with websocket by
- Run Human pose estimation module on your laptop with WebSocket by
```sh
yarn websocket

8
docs/en/sitl.md
View File

@@ -3,9 +3,9 @@ PX4 Simulation
Main article: https://dev.px4.io/en/simulation/
PX4 simulation is possible in Linux and macOS with the use of physical environment simulation systems [jMavSim](https://pixhawk.org/dev/hil/jmavsim) and [the Gazebo](http://gazebosim.org).
PX4 simulation is possible in Linux and macOS with the use of physical environment simulation systems [jMAVSim](https://pixhawk.org/dev/hil/jmavsim) and [the Gazebo](http://gazebosim.org).
jMavSim is a lightweight environment intended only for testing multi-rotor aircraft systems; Gazebo is a versatile environment for all types of robots.
jMAVSim is a lightweight environment intended only for testing multi-rotor aircraft systems; Gazebo is a versatile environment for all types of robots.
Launching PX4 SITL
--
@@ -17,12 +17,12 @@ git clone https://github.com/PX4/Firmware.git
cd Firmware
```
jMavSim
jMAVSim
--
Main article: https://dev.px4.io/en/simulation/jmavsim.html
For simulation using the jMavSim lightweight environment, use the following command:
For simulation using the jMAVSim lightweight environment, use the following command:
```(bash)
make posix_sitl_default jmavsim

2
docs/ru/gloss.md
View File

@@ -11,7 +11,7 @@
## Полетный контроллер / автопилот
**1\.** Специализированная плата, спроектированная для управления мультикоптером, самолетом или другим аппаратом. Примеры:
Pixhawk, Ardupilot, Naze32, CC3D.
Pixhawk, ArduPilot, Naze32, CC3D.
**2\.** Программное обеспечение для платы управления мультикоптером. Примеры: PX4, APM, CleanFlight.

8
docs/ru/sitl.md
View File

@@ -4,9 +4,9 @@
Основная статья: https://dev.px4.io/en/simulation/
Симуляция PX4 возможна в ОС Linux и macOS с использованием систем симуляции физической среды [jMavSim](https://pixhawk.org/dev/hil/jmavsim) и [Gazebo](http://gazebosim.org).
Симуляция PX4 возможна в ОС GNU/Linux и macOS с использованием систем симуляции физической среды [jMAVSim](https://pixhawk.org/dev/hil/jmavsim) и [Gazebo](http://gazebosim.org).
jMavSim является легковесной средой, предназначенной только для тестирование мультироторных летательных систем; Gazebo – универсальная среда для любых типов роботов.
jMAVSim является легковесной средой, предназначенной только для тестирование мультироторных летательных систем; Gazebo – универсальная среда для любых типов роботов.
## Запуск PX4 SITL
@@ -17,11 +17,11 @@ git clone https://github.com/PX4/Firmware.git
cd Firmware
```
## jMavSim
## jMAVSim
Основная статья: https://dev.px4.io/en/simulation/jmavsim.html
Для симуляции с использованием легковесной среды jMavSim используйте команду:
Для симуляции с использованием легковесной среды jMAVSim используйте команду:
```bash
make posix_sitl_default jmavsim

2
docs/ru/ssh.md
View File

@@ -5,7 +5,7 @@
Для доступа по SSH необходимо [подключиться к Raspberry Pi по Wi-Fi](wifi.md) (также возможно подключение через Ethernet-кабель).
В Linux или macOS необходимо запустить Терминал и выполнить команду:
В GNU/Linux или macOS необходимо запустить Терминал и выполнить команду:
```bash
ssh pi@192.168.11.1