From a4e4a119a2359517467ba7e1a0a830ecdc82ac91 Mon Sep 17 00:00:00 2001 From: Annika Backstrom Date: Sat, 14 Dec 2019 14:51:06 -0500 Subject: [PATCH] Update README with more dev instructions --- README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 54e9f00..5ed3758 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,18 @@ for my own convenience: 5. `virtualenv lib` # make a python virtualenv 6. `lib/bin/pip install -r requirements.txt` -TODO: Can this be streamlined? Maybe move Makefile commands into `npm` commands. +## Development + +`npm run watch` will use nodemon to restart the server when any file changes. + +Dummy versions of `mpg321` and the tag reader are available in the `bin` +directory. These are node scripts, so you would include them in your +`config.json` like so: + + { + "tag_reader": ["node", "./bin/tag-reader-dummy"], + "mpg321": ["node", "./bin/mpg321-dummy"] + } ## config.json