Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clearer instructions for using the Makefile #15

Open
tompollard opened this issue Nov 23, 2016 · 0 comments
Open

Clearer instructions for using the Makefile #15

tompollard opened this issue Nov 23, 2016 · 0 comments

Comments

@tompollard
Copy link
Contributor

It would be helpful to provide instructions for using the Makefile, perhaps in the Readme.md. Also consider including a help rule in the Makefile to print usage instructions when someone tries to run make with no arguments. e.g. add the following chunk above all:

help:
	@echo '----------------------------------------------------------------------------'
	@echo ' Makefile for de-identifying clinical data '
	@echo '                                                                            '
	@echo ' Usage: '
	@echo '                                                                            '
	@echo ' Deidentify a dataset in the X directory:  '
	@echo '                                                                            '
	@echo '             make all                         '
	@echo '                                                                            '
	@echo ' Run the deidentification script against a test dataset:  '
	@echo '                                                                            '
	@echo '             make test                         '
	@echo '----------------------------------------------------------------------------'
	@echo '                                                                            '
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant