[GEODE-5554] Standardize naming of Geode Native example *.md files

• Type: Sub-task
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Fix Version/s: 1.7.0
• Component/s: docs, native client
• Labels: pull-request-available
• Assignee: Dave Barnes
• Reporter: Dave Barnes
• Created: 09/Aug/18 17:42
• Updated: 03/Oct/19 22:30
• Resolved: 16/Aug/18 22:05

Description

The *.md files describing how to build and run examples do not follow a consistent naming pattern. Current state:

• examples/dotnet/README.md describes building examples, refers user to README.md in each example directory for running.
• examples/cpp/BUILDING.md describes building examples and running them. Only one individual example has its own README.md file.

Problems:

• Top-level file in dotnet should have 'BUILD' in its name.
• The geode-native distribution has a 'BUILDING.md' in its root directory. Top-level files in both dotnet and cpp should not be named 'BUILDING.md', because it's confusing to the user when both are open on the desktop at the same time.
• The cpp examples should follow the dotnet pattern of an individual README.md for each example with instructions for running.
• The cpp examples should follow the practice recommended for the dotnet examples of copying the installed example to a personal workspace before building and running. This practice preserves a clean copy from which the user can start over, if necessary.

Recommendations:

• Rename example build instructions to BUILD-EXAMPLES.md for both dotnet and cpp
• Add README.md to individual cpp examples
• Update all CMake scripts to deploy these *.md files when examples are installed.

 

 

Issue Links

• links to: GitHub Pull Request #332