From 461851a0709dd66e53daa7ec173c8e577c38d481 Mon Sep 17 00:00:00 2001 From: alisdair sullivan Date: Tue, 6 Mar 2012 00:28:59 -0800 Subject: [PATCH] update README to reflect new build/test instructions --- README.markdown | 2 +- rebar.config | 53 +++++++++++++++++++++++++++++------------------ rebar.test.config | 50 ++++++++++++++++++++++++-------------------- 3 files changed, 62 insertions(+), 43 deletions(-) diff --git a/README.markdown b/README.markdown index 91475b3..5bcbbc5 100644 --- a/README.markdown +++ b/README.markdown @@ -6,7 +6,7 @@ copyright 2011, 2012 alisdair sullivan jsx is released under the terms of the [MIT][MIT] license -to build jsx, `make` or `./rebar compile` +to build jsx, use `make`. to run the test suite, use `make test` ## api ## diff --git a/rebar.config b/rebar.config index 303b263..23f76fd 100644 --- a/rebar.config +++ b/rebar.config @@ -1,23 +1,36 @@ -{erl_opts, [{i, "src"}, {src_dirs, ["src"]}, - warn_unused_vars, - warn_export_all, - warn_shadow_vars, - warn_unused_import, - warn_unused_function, - warn_bif_clash, - warn_unused_record, - warn_deprecated_function, - warn_obsolete_guard, - strict_validation, - warn_export_vars, - warn_exported_vars]}. -{dialyzer_opts, [{warnings, [unmatched_returns, error_handling, race_conditions, behaviours]}]}. +%% uncomment to get verbose output from test suite +%% {eunit_opts, [verbose]}. + +{erl_opts, [ + {i, "src"}, + {src_dirs, ["src"]}, + warn_unused_vars, + warn_export_all, + warn_shadow_vars, + warn_unused_import, + warn_unused_function, + warn_bif_clash, + warn_unused_record, + warn_deprecated_function, + warn_obsolete_guard, + strict_validation, + warn_export_vars, + warn_exported_vars +]}. + +{dialyzer_opts, [{warnings, [ + unmatched_returns, + error_handling, + race_conditions, + behaviours +]}]}. + {xref_checks, [undefined_function_calls]}. + {cover_enabled, true}. -{deps, [ - {'nicedecimal', - ".*", - {git, "git://github.com/talentdeficit/nicedecimal.git"} - } -]}. +{deps, [{ + 'nicedecimal', + ".*", + {git, "git://github.com/talentdeficit/nicedecimal.git"} +}]}. diff --git a/rebar.test.config b/rebar.test.config index ae6cc33..600145d 100644 --- a/rebar.test.config +++ b/rebar.test.config @@ -1,30 +1,36 @@ -%% edit eunit_test_path if you want to run your own tests, use "../" not "./" as -%% rebar changes to working dir to .eunit when running tests +%% edit eunit_test_path if you want to run your own tests, use "../" not +%% "./" as rebar changes working dir to .eunit when running tests {eunit_compile_opts, [{d, eunit_test_path, "../test/cases"}]}. %% uncomment to get verbose output from test suite %% {eunit_opts, [verbose]}. -{erl_opts, [{i, "src"}, {src_dirs, ["src"]}, - warn_unused_vars, - warn_export_all, - warn_shadow_vars, - warn_unused_import, - warn_unused_function, - warn_bif_clash, - warn_unused_record, - warn_deprecated_function, - warn_obsolete_guard, - strict_validation, - warn_export_vars, - warn_exported_vars]}. -{dialyzer_opts, [{warnings, [unmatched_returns, error_handling, race_conditions, behaviours]}]}. +{erl_opts, [ + {i, "src"}, + {src_dirs, ["src"]}, + warn_unused_vars, + warn_export_all, + warn_shadow_vars, + warn_unused_import, + warn_unused_function, + warn_bif_clash, + warn_unused_record, + warn_deprecated_function, + warn_obsolete_guard, + strict_validation, + warn_export_vars, + warn_exported_vars +]}. + +{dialyzer_opts, [{warnings, [ + unmatched_returns, + error_handling, + race_conditions, + behaviours +]}]}. + {xref_checks, [undefined_function_calls]}. + {cover_enabled, true}. -{deps, [ - {'meck', - ".*", - {git, "git://github.com/eproxus/meck.git"} - } -]}. \ No newline at end of file +{deps, [{'meck', ".*", {git, "git://github.com/eproxus/meck.git"}}]}. \ No newline at end of file