Skip to content

Commit 9b18a5e

Browse files
committed
Move Makefile help to separate docs file
1 parent 16ab718 commit 9b18a5e

2 files changed

Lines changed: 24 additions & 23 deletions

File tree

Makefile

Lines changed: 1 addition & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -3,29 +3,7 @@
33
.PHONY: help
44

55
help:
6-
@echo ''
7-
@echo 'Usage: make <cmd>'
8-
@echo ''
9-
@echo ' make help Print this message.'
10-
@echo ' make notes Search for code annotations.'
11-
@echo ' make list-sources List all source files (excluding examples and tests).'
12-
@echo ' make list-examples List all example files.'
13-
@echo ' make list-tests List all test files.'
14-
@echo ' make list-files List files.'
15-
@echo ' make examples Run examples.'
16-
@echo ' make test Run tests.'
17-
@echo ' make test-summary Run tests and output a test summary.'
18-
@echo ' make test-cov Run tests with code coverage.'
19-
@echo ' make test-browsers Run tests in a local web browser.'
20-
@echo ' make view-cov View the most recent code coverage report.'
21-
@echo ' make view-browser-tests View browser tests in a local web browser.'
22-
@echo ' make docs-src Generate source documentation.'
23-
@echo ' make view-src-docs View source documentation.'
24-
@echo ' make lint Run code linting.'
25-
@echo ' make install Install dependencies.'
26-
@echo ' make clean Clean the build directory.'
27-
@echo ' make clean-node Remove Node dependencies.'
28-
@echo ''
6+
cat ./docs/make/usage.txt
297

308

319
#############

docs/make/usage.txt

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
2+
Usage: make <cmd>
3+
4+
make help Print this message.
5+
make notes Search for code annotations.
6+
make list-sources List all source files (excluding examples and tests).
7+
make list-examples List all example files.
8+
make list-tests List all test files.
9+
make list-files List files.
10+
make examples Run examples.
11+
make test Run tests.
12+
make test-summary Run tests and output a test summary.
13+
make test-cov Run tests with code coverage.
14+
make test-browsers Run tests in a local web browser.
15+
make view-cov View the most recent code coverage report.
16+
make view-browser-tests View browser tests in a local web browser.
17+
make docs-src Generate source documentation.
18+
make view-src-docs View source documentation.
19+
make lint Run code linting.
20+
make install Install dependencies.
21+
make clean Clean the build directory.
22+
make clean-node Remove Node dependencies.
23+

0 commit comments

Comments
 (0)