Skip to content

Commit

Permalink
Update examples: minor changes, rename, update .gitignore
Browse files Browse the repository at this point in the history
.gitignore, Makefile: add missing files, sort example filenames.
Makefile.FLTK: update and extend FLTKCONFIG definition examples.

Rename README.examples to README.txt (easier for Windows users).

README.txt: minor edits, fix link, remove trailing whitespace.
  • Loading branch information
Albrecht Schlosser committed Dec 10, 2018
1 parent 6c87618 commit 810b914
Show file tree
Hide file tree
Showing 4 changed files with 22 additions and 19 deletions.
3 changes: 2 additions & 1 deletion .gitignore
Expand Up @@ -78,8 +78,8 @@
/examples/howto-simple-svg
/examples/howto-text-over-image-button
/examples/menubar-add
/examples/nativefilechooser-simple-app
/examples/nativefilechooser-simple
/examples/nativefilechooser-simple-app
/examples/OpenGL3-glut-test
/examples/OpenGL3test
/examples/progress-simple
Expand All @@ -95,6 +95,7 @@
/examples/tabs-simple
/examples/textdisplay-with-colors
/examples/texteditor-simple
/examples/texteditor-with-dynamic-colors
/examples/tree-as-container
/examples/tree-custom-draw-items
/examples/tree-custom-sort
Expand Down
8 changes: 4 additions & 4 deletions examples/Makefile
Expand Up @@ -16,27 +16,27 @@ ALL = clipboard$(EXEEXT) \
howto-simple-svg$(EXEEXT) \
howto-text-over-image-button$(EXEEXT) \
menubar-add$(EXEEXT) \
nativefilechooser-simple$(EXEEXT) \
nativefilechooser-simple-app$(EXEEXT) \
nativefilechooser-simple$(EXEEXT) \
progress-simple$(EXEEXT) \
shapedwindow$(EXEEXT) \
simple-terminal$(EXEEXT) \
SVG_File_Surface$(EXEEXT) \
table-as-container$(EXEEXT) \
table-simple$(EXEEXT) \
table-sort$(EXEEXT) \
table-spreadsheet$(EXEEXT) \
table-spreadsheet-with-keyboard-nav$(EXEEXT) \
table-with-keynav$(EXEEXT) \
tabs-simple$(EXEEXT) \
simple-terminal$(EXEEXT) \
SVG_File_Surface$(EXEEXT) \
textdisplay-with-colors$(EXEEXT) \
texteditor-simple$(EXEEXT) \
texteditor-with-dynamic-colors$(EXEEXT) \
tree-simple$(EXEEXT) \
tree-as-container$(EXEEXT) \
tree-custom-draw-items$(EXEEXT) \
tree-custom-sort$(EXEEXT) \
tree-of-tables$(EXEEXT) \
tree-simple$(EXEEXT) \
wizard-simple$(EXEEXT)

# default target -- build everything
Expand Down
3 changes: 2 additions & 1 deletion examples/Makefile.FLTK
Expand Up @@ -6,7 +6,8 @@
# on your system. Common examples:
#
# FLTKCONFIG = /usr/local/bin/fltk-config
# FLTKCONFIG = /usr/local/src/fltk-1.3.x-svn/fltk-config
# FLTKCONFIG = /usr/local/src/fltk-1.4.x/fltk-config
# FLTKCONFIG = ../build/fltk-config # if ../build == CMake build directory
#
# Set .SILENT in your Makefile if you want 'quieter' builds.
#
Expand Down
27 changes: 14 additions & 13 deletions examples/README.examples → examples/README.txt
Expand Up @@ -6,7 +6,7 @@ FLTK EXAMPLE PROGRAMS
programmers. The "*-simple.cxx" files are a good starting point for
those new to FLTK.

The programs in this directory are NOT built automatically
The programs in this directory are NOT built automatically
when you build FLTK; you have to manually build them.

The goals of these example programs:
Expand All @@ -15,7 +15,7 @@ FLTK EXAMPLE PROGRAMS

o Show simple examples of how to use widgets to new users of FLTK.

o Show intermediate or advanced examples of techniques often
o Show intermediate or advanced examples of techniques often
misused or hard to document

o Demonstrate code that are FAQs on the newsgroup forum.
Expand All @@ -40,12 +40,12 @@ NEW SUBMISSIONS: RECOMMENDED PRACTICES
just a .cxx/.h file pair should have their own subdirectory.

Data files common to several examples should be located in the
examples/data directory.
Ancillary data files should be as small as possible, to keep the
examples/data directory.

Ancillary data files should be as small as possible, to keep the
distribution tar files small. Avoid high resolution images or
uncompressed images when possible.
uncompressed images when possible.

Examples that need large data sets (HD images, etc) should not
be part of the FLTK distribution; they can be provided as separate
packages (eg. as articles or external links).
Expand All @@ -72,16 +72,17 @@ NAMING CONVENTIONS
with that widget's name in lowercase, eg. "table.cxx" for Fl_Table.

Demonstrations of a particular technique should start with
"howto-xxx.cxx" to avoid naming conflicts with future widgets
"howto-xxx.cxx" to avoid naming conflicts with future widgets
of the same name.

xxx-simple.cxx -- Simplest possible example of widget xxx
eg. table-simple.cxx
eg. "table-simple.cxx"

xxx-<technique>.cxx -- A particular "technique" using widget xxx
eg. "table-spreadsheet.cxx"

howto-<technique>.cxx -- Demonstrate a particular technique, eg. "howto-threading.cxx"
howto-<technique>.cxx -- Demonstrate a particular technique,
eg. "howto-threading.cxx"

Some example programs may depend on multiple files. To avoid
cluttering up the top level examples directory, such examples will
Expand All @@ -106,17 +107,17 @@ HISTORY
applications programmers.

The fltk/examples directory was created in FLTK 1.3.0 to separate
'good programming examples' from the test suite code.
'good programming examples' from the test suite code.


DISCLAIMER

The examples in this directory are provided 'as-is', without any express
or implied warranty. In no event will the authors be held liable for
any damages arising from the use of this software.


BUGS

If you find a bug, please report it through the fltk STR form at
http://fltk.org/str.php
https://www.fltk.org/str.php

0 comments on commit 810b914

Please sign in to comment.