From 38f472c3b0a6688025ee21438243f44c90e5ef62 Mon Sep 17 00:00:00 2001 From: nick black Date: Tue, 5 Jan 2021 20:02:20 -0500 Subject: [PATCH] example book chapters #785 --- doc/examples/src/SUMMARY.md | 16 +++++++++++++++- doc/examples/src/{chapter_1.md => basics.md} | 2 +- doc/examples/src/boxes.md | 1 + doc/examples/src/colors.md | 1 + doc/examples/src/directmode.md | 1 + doc/examples/src/fdwidget.md | 1 + doc/examples/src/fullscreen.md | 1 + doc/examples/src/input.md | 1 + doc/examples/src/media.md | 1 + doc/examples/src/menus.md | 1 + doc/examples/src/planes.md | 1 + doc/examples/src/plots.md | 1 + doc/examples/src/reader.md | 1 + doc/examples/src/reels.md | 1 + doc/examples/src/selectors.md | 1 + doc/examples/src/writetext.md | 1 + 16 files changed, 30 insertions(+), 2 deletions(-) rename doc/examples/src/{chapter_1.md => basics.md} (99%) create mode 100644 doc/examples/src/boxes.md create mode 100644 doc/examples/src/colors.md create mode 100644 doc/examples/src/directmode.md create mode 100644 doc/examples/src/fdwidget.md create mode 100644 doc/examples/src/fullscreen.md create mode 100644 doc/examples/src/input.md create mode 100644 doc/examples/src/media.md create mode 100644 doc/examples/src/menus.md create mode 100644 doc/examples/src/planes.md create mode 100644 doc/examples/src/plots.md create mode 100644 doc/examples/src/reader.md create mode 100644 doc/examples/src/reels.md create mode 100644 doc/examples/src/selectors.md create mode 100644 doc/examples/src/writetext.md diff --git a/doc/examples/src/SUMMARY.md b/doc/examples/src/SUMMARY.md index 7390c8289..23ca129aa 100644 --- a/doc/examples/src/SUMMARY.md +++ b/doc/examples/src/SUMMARY.md @@ -1,3 +1,17 @@ # Summary -- [Chapter 1](./chapter_1.md) +- [Basics](./basics.md) +- [Direct mode](./directmode.md) +- [Fullscreen mode](./fullscreen.md) +- [Writing text](./writetext.md) +- [Colors](./colors.md) +- [Drawing boxes](./boxes.md) +- [Reading input](./input.md) +- [Planes and transparency](./planes.md) +- [Selector widgets](./selectors.md) +- [Menus](./menus.md) +- [Plots and progress bars](./plots.md) +- [Rendering media](./media.md) +- [Subprocesses](./fdwidget.md) +- [The reader widget](./reader.md) +- [Reels](./reels.md) diff --git a/doc/examples/src/chapter_1.md b/doc/examples/src/basics.md similarity index 99% rename from doc/examples/src/chapter_1.md rename to doc/examples/src/basics.md index 426a6a6df..eb91eb167 100644 --- a/doc/examples/src/chapter_1.md +++ b/doc/examples/src/basics.md @@ -1,4 +1,4 @@ -# Chapter 1 +# Basics Notcurses is a library for terminal applications—programs which do not require a GUI environment, and write output as cells rather than pixels. Within a GUI diff --git a/doc/examples/src/boxes.md b/doc/examples/src/boxes.md new file mode 100644 index 000000000..f73a9cbda --- /dev/null +++ b/doc/examples/src/boxes.md @@ -0,0 +1 @@ +# Boxes diff --git a/doc/examples/src/colors.md b/doc/examples/src/colors.md new file mode 100644 index 000000000..302161a23 --- /dev/null +++ b/doc/examples/src/colors.md @@ -0,0 +1 @@ +# Colors diff --git a/doc/examples/src/directmode.md b/doc/examples/src/directmode.md new file mode 100644 index 000000000..35bc56802 --- /dev/null +++ b/doc/examples/src/directmode.md @@ -0,0 +1 @@ +# Direct mode diff --git a/doc/examples/src/fdwidget.md b/doc/examples/src/fdwidget.md new file mode 100644 index 000000000..6235e0dd3 --- /dev/null +++ b/doc/examples/src/fdwidget.md @@ -0,0 +1 @@ +# Subprocesses diff --git a/doc/examples/src/fullscreen.md b/doc/examples/src/fullscreen.md new file mode 100644 index 000000000..bb0250722 --- /dev/null +++ b/doc/examples/src/fullscreen.md @@ -0,0 +1 @@ +# Fullscreen mode diff --git a/doc/examples/src/input.md b/doc/examples/src/input.md new file mode 100644 index 000000000..73f1b5ef1 --- /dev/null +++ b/doc/examples/src/input.md @@ -0,0 +1 @@ +# Reading input diff --git a/doc/examples/src/media.md b/doc/examples/src/media.md new file mode 100644 index 000000000..8dc3c31eb --- /dev/null +++ b/doc/examples/src/media.md @@ -0,0 +1 @@ +# Rendering media diff --git a/doc/examples/src/menus.md b/doc/examples/src/menus.md new file mode 100644 index 000000000..c587b177b --- /dev/null +++ b/doc/examples/src/menus.md @@ -0,0 +1 @@ +# Menus diff --git a/doc/examples/src/planes.md b/doc/examples/src/planes.md new file mode 100644 index 000000000..9c08fe180 --- /dev/null +++ b/doc/examples/src/planes.md @@ -0,0 +1 @@ +# Planes and transparency diff --git a/doc/examples/src/plots.md b/doc/examples/src/plots.md new file mode 100644 index 000000000..31d10e30a --- /dev/null +++ b/doc/examples/src/plots.md @@ -0,0 +1 @@ +# Plots and progress bars diff --git a/doc/examples/src/reader.md b/doc/examples/src/reader.md new file mode 100644 index 000000000..c0759dddd --- /dev/null +++ b/doc/examples/src/reader.md @@ -0,0 +1 @@ +# The reader widget diff --git a/doc/examples/src/reels.md b/doc/examples/src/reels.md new file mode 100644 index 000000000..25b8689b1 --- /dev/null +++ b/doc/examples/src/reels.md @@ -0,0 +1 @@ +# Reels diff --git a/doc/examples/src/selectors.md b/doc/examples/src/selectors.md new file mode 100644 index 000000000..6fe1e9a74 --- /dev/null +++ b/doc/examples/src/selectors.md @@ -0,0 +1 @@ +# Selector widgets diff --git a/doc/examples/src/writetext.md b/doc/examples/src/writetext.md new file mode 100644 index 000000000..dc989f656 --- /dev/null +++ b/doc/examples/src/writetext.md @@ -0,0 +1 @@ +# Writing text