diff options
author | William Carroll <wpcarro@gmail.com> | 2020-02-12T16·58+0000 |
---|---|---|
committer | William Carroll <wpcarro@gmail.com> | 2020-02-12T16·58+0000 |
commit | fabf1c9334a86d55be133da851cafccc9e6319fe (patch) | |
tree | e5c07cbe676c4955d9a48742d00e0081b16b3446 /tools/run/README.md | |
parent | 5ec5a6da8cbfe3c35558fd2c17ef779b5d0ccb54 (diff) |
Tidy up structure of briefcase
I had a spare fifteen minutes and decided that I should tidy up my monorepo. The work of tidying up is not finished; this is a small step in the right direction. TL;DR - Created a tools directory - Created a scratch directory (see README.md for more information) - Added README.md to third_party - Renamed delete_dotfile_symlinks -> symlinkManager - Packaged symlinkManager as an executable symlink-mgr using buildGo
Diffstat (limited to 'tools/run/README.md')
-rw-r--r-- | tools/run/README.md | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/tools/run/README.md b/tools/run/README.md new file mode 100644 index 000000000000..d3cccecf910c --- /dev/null +++ b/tools/run/README.md @@ -0,0 +1,30 @@ +# run + +Simplify the commands you call to run scripts on the command line. + +```shell +> run path/to/file.py +> run path/to/file.ts +``` + +## How? + +Define a run.json configuration mapping commands to filename extensions like +so: +```json +{ + ".ts": "npx ts-node $file", + ".py": "python3 $file" +} +``` + +Then call `run path/to/some/file.ts` on the command line, and `npx ts-node +file.ts` will run. + +## Installation + +Install `run` using Nix. + +```shell +> nix-env -iA briefcase.run +``` |