diff --git a/README.md b/README.md index a7ed0dc..f37cce4 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,25 @@ # erlang-terms-validate -A helper script to syntactically validate an Erlang terms config file \ No newline at end of file +A helper script to syntactically validate an Erlang terms config file + +# Setup + +Get started like so: + +1. Clone repo into arbitrary path `` + +1. Make `erlang-terms-validate.escript` executable + + ``` + chmod +x /erlang-terms-validate.escript + ``` + +1. Symlink to file, for example + + ``` + sudo ln -s /erlang-terms-validate.escript /usr/local/bin/erlang-terms-validate + ``` + +# Credits + +[Stack Overflow user Jesse Gumm](https://stackoverflow.com/users/318025/chops) aka `chops` in November 2012 post [stackoverflow.com/a/13424207](https://stackoverflow.com/a/13424207) diff --git a/erlang-terms-validate.escript b/erlang-terms-validate.escript new file mode 100644 index 0000000..3b2fc2e --- /dev/null +++ b/erlang-terms-validate.escript @@ -0,0 +1,4 @@ +#!/usr/bin/env escript +main([ConfigFile]) -> + {ok, Terms} = file:consult(ConfigFile), + io:format("~p~n",[Terms]).