Skip to content

Commit dccd5da

Browse files
authored
clarified make run detects missing components
1 parent fb52188 commit dccd5da

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

MAKEFILE_GUIDANCE.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ App Makefiles build source code, download or copy (from other repo subdirectorie
99
- **make data** : Download data (images, etc.) If no data is required this may be an empty target.
1010
- **make deps** : Download/Prepare/optimize networks. If not needed create empty target.
1111
- **make all** : Prepares everything needed to run the application including other projects in the repository. Should not run application, should not popup GUI.
12-
- **make run** : Runs the application with some set of default parameters/settings/configuration. 'make run' must always execute the program without the need for other parameters. Users expect to see some working output by just typing 'make run'
12+
- **make run** : Runs the application with some set of default parameters/settings/configuration. 'make run' must always execute the program without the need for other parameters. Users expect to see some working output by just typing `make run`. This Makefile target should also detect the case of missing required components and if it detects such a case it should diret the user to run `make install-reqs` to remedy the situation.
1313
- **make clean** : Removes all the files in this project directory that get created when making or running this project. Should not clean other projects in the repository. After running 'make clean' the only files in the directory should be those that are in the repository.
14-
- **make install-reqs**: Installs any required components for the application or gives instructions for installing those components. If no other components are required then this target may be empty.
14+
- **make install-reqs**: Installs any required system/OS components for the application or gives instructions for installing those components. If no other components are required then this target may be empty. This is the only place that the users installed components/packages should be modified.
1515
- **make uninstall-reqs**: if the `make install-reqs` installs any components, then this target should uninstall those components or give instructions for uninstalling them. If not applicable then this target may be empty.
1616

1717
## Makefiles for neural networks
@@ -22,7 +22,7 @@ App Makefiles build source code, download or copy (from other repo subdirectorie
2222
- **make all** : makes the following targets: deps, compile_model
2323
- **make deps** : Download/Prepare networks to be optimized. If not needed this may be an empty target
2424
- **make compile_model** : Run the OpenVINO toolkit's Model Optimizer tool to create an optimized OpenVINO IR neural network (.bin and .xml) for the network
25-
- **make run** : Run a simple program demonstrating the use of the optimized network. This may invoke an application under the ncappzoo/apps directory hierarchy or from within this project's directory
25+
- **make run** : Run a simple program demonstrating the use of the optimized network. This may invoke an application under the ncappzoo/apps directory hierarchy or from within this project's directory. This Makefile target should also detect the case of missing required components and if it detects such a case it should diret the user to run `make install-reqs` to remedy the situation.
2626
- **make clean** : Removes all the files in this project directory that may get created when making or running this project. Should not clean other projects in the repository. After running 'make clean' the only files in the directory should be those that are in the repository.
27-
- **make install-reqs**: Installs any required components for the neural network or gives instructions for installing those components. If no other components are required then this target may be empty.
27+
- **make install-reqs**: Installs any required components for the neural network or gives instructions for installing those components. If no other components are required then this target may be empty. This is the only place that the users installed components/packages should be modified.
2828
- **make uninstall-reqs**: if the `make install-reqs` installs any components, then this target should uninstall those components or give instructions for uninstalling them. If not applicable then this target may be empty.

0 commit comments

Comments
 (0)