Skip to content

Commit

Permalink
Rewritten READMEs to Markdown
Browse files Browse the repository at this point in the history
  • Loading branch information
w8jcik authored and btashton committed Jul 25, 2020
1 parent 51e6645 commit 21049ec
Show file tree
Hide file tree
Showing 56 changed files with 7,147 additions and 6,836 deletions.
332 changes: 174 additions & 158 deletions README.md

Large diffs are not rendered by default.

3,356 changes: 1,652 additions & 1,704 deletions examples/README.md

Large diffs are not rendered by default.

1,056 changes: 633 additions & 423 deletions examples/bastest/README.md

Large diffs are not rendered by default.

67 changes: 35 additions & 32 deletions examples/camera/README.md
Original file line number Diff line number Diff line change
@@ -1,39 +1,42 @@
examples/camera
^^^^^^^^^^^^^^^
# Examples / `camera` Camera Snapshot

This sample is implemented as 'camera' command on NuttX Shell.
The synopsys of the command is as below.
This sample is implemented as `camera` command on NuttX Shell. The synopsys of
the command is as below.

nsh> camera ([-jpg]) ([capture num])
```
nsh> camera ([-jpg]) ([capture num])
-jpg : this option is set for storing JPEG file into a strage.
: If this option isn't set capturing raw YUV422 data in a file.
: raw YUV422 is default.
-jpg : this option is set for storing JPEG file into a strage.
: If this option isn't set capturing raw YUV422 data in a file.
: raw YUV422 is default.
capture num : this option instructs number of taking pictures.
: 10 is default.
Storage will be selected automatically based on the available storage option.
capture num : this option instructs number of taking pictures.
: 10 is default.
```

Execution example:
Storage will be selected automatically based on the available storage option.

nsh> camera
nximage_listener: Connected
nximage_initialize: Screen resolution (320,240)
Take 10 pictures as YUV file in /mnt/sd0 after 5000 mili-seconds.
After finishing taking pictures, this app will be finished after 10000 mili-seconds.
Expier time is pasted.
Start captureing...
FILENAME:/mnt/sd0/VIDEO001.YUV
FILENAME:/mnt/sd0/VIDEO002.YUV
FILENAME:/mnt/sd0/VIDEO003.YUV
FILENAME:/mnt/sd0/VIDEO004.YUV
FILENAME:/mnt/sd0/VIDEO005.YUV
FILENAME:/mnt/sd0/VIDEO006.YUV
FILENAME:/mnt/sd0/VIDEO007.YUV
FILENAME:/mnt/sd0/VIDEO008.YUV
FILENAME:/mnt/sd0/VIDEO009.YUV
FILENAME:/mnt/sd0/VIDEO010.YUV
Finished captureing...
Expier time is pasted.
nximage_listener: Lost server connection: 117
Execution example:

```
nsh> camera
nximage_listener: Connected
nximage_initialize: Screen resolution (320,240)
Take 10 pictures as YUV file in /mnt/sd0 after 5000 mili-seconds.
After finishing taking pictures, this app will be finished after 10000 mili-seconds.
Expier time is pasted.
Start capturing...
FILENAME:/mnt/sd0/VIDEO001.YUV
FILENAME:/mnt/sd0/VIDEO002.YUV
FILENAME:/mnt/sd0/VIDEO003.YUV
FILENAME:/mnt/sd0/VIDEO004.YUV
FILENAME:/mnt/sd0/VIDEO005.YUV
FILENAME:/mnt/sd0/VIDEO006.YUV
FILENAME:/mnt/sd0/VIDEO007.YUV
FILENAME:/mnt/sd0/VIDEO008.YUV
FILENAME:/mnt/sd0/VIDEO009.YUV
FILENAME:/mnt/sd0/VIDEO010.YUV
Finished capturing...
Expier time is pasted.
nximage_listener: Lost server connection: 117
```
4 changes: 2 additions & 2 deletions examples/camera/camera_main.c
Original file line number Diff line number Diff line change
Expand Up @@ -552,7 +552,7 @@ int main(int argc, FAR char *argv[])

while (1)
{
printf("Start captureing...\n");
printf("Start capturing...\n");
ret = start_stillcapture(v_fd, capture_type);
if (ret != OK)
{
Expand Down Expand Up @@ -587,7 +587,7 @@ int main(int argc, FAR char *argv[])
}

RESET_INITIAL_TIME(then);
printf("Finished captureing...\n");
printf("Finished capturing...\n");
}

exit_this_app:
Expand Down
25 changes: 15 additions & 10 deletions examples/flash_test/README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,23 @@
# Examples / `flash_test` SMART Flash Device Test

Install Program
===============
```
Author: Ken Pettit
Date: April 24, 2013
```

Source: NuttX
Author: Ken Pettit
Date: April 24, 2013
This application performs a SMART flash block device test. This test performs a
sector allocate, read, write, free and garbage collection test on a SMART MTD
block device. This test can be built only as an NSH command

This application performs a SMART flash block device test. This test performs a sector allocate, read, write, free and garbage collection test on a SMART MTD block device. This test can be built only as an NSH command

NOTE: This test uses internal OS interfaces and so is not available in the NUTTX kernel build
**Note**: This test uses internal OS interfaces and so is not available in the
NUTTX kernel build

```
Usage:
flash_test mtdblock_device
flash_test mtdblock_device
Additional options:
--force to replace existing installation
--force to replace existing installation
```
22 changes: 12 additions & 10 deletions examples/flowc/README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,17 @@
General Usage Instructions:
# Examples / `flowc`

1. The receiver side enter, start the receiver program. The receiver
is now waiting to receive data on the configured serial port
General Usage Instructions:

2. On the sender side start the sender program. This will send data to
the receiver which will verify that no data is lost.
1. The receiver side enter, start the receiver program. The receiver is now
waiting to receive data on the configured serial port.
2. On the sender side start the sender program. This will send data to the
receiver which will verify that no data is lost.

On Linux, you can alternatively do:
On Linux, you can alternatively do:

$ stty -F /dev/ttyACM0 crtscts
$ cat testdata.dat >/dev/ttyACM0
```bash
$ stty -F /dev/ttyACM0 crtscts
$ cat testdata.dat >/dev/ttyACM0
```

where you need to replace /dev/ttyACM0 with your selected serial
device.
where you need to replace `/dev/ttyACM0` with your selected serial device.
Loading

0 comments on commit 21049ec

Please sign in to comment.