You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: MAKEFILE_GUIDANCE.md
+4-4
Original file line number
Diff line number
Diff line change
@@ -9,9 +9,9 @@ App Makefiles build source code, download or copy (from other repo subdirectorie
9
9
-**make data** : Download data (images, etc.) If no data is required this may be an empty target.
10
10
-**make deps** : Download/Prepare/optimize networks. If not needed create empty target.
11
11
-**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.
13
13
-**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.
15
15
-**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.
16
16
17
17
## Makefiles for neural networks
@@ -22,7 +22,7 @@ App Makefiles build source code, download or copy (from other repo subdirectorie
22
22
-**make all** : makes the following targets: deps, compile_model
23
23
-**make deps** : Download/Prepare networks to be optimized. If not needed this may be an empty target
24
24
-**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.
26
26
-**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.
28
28
-**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