update README to reflect new build/test instructions
This commit is contained in:
parent
c50f42a70c
commit
461851a070
3 changed files with 62 additions and 43 deletions
|
@ -6,7 +6,7 @@ copyright 2011, 2012 alisdair sullivan
|
||||||
|
|
||||||
jsx is released under the terms of the [MIT][MIT] license
|
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 ##
|
## api ##
|
||||||
|
|
27
rebar.config
27
rebar.config
|
@ -1,4 +1,9 @@
|
||||||
{erl_opts, [{i, "src"}, {src_dirs, ["src"]},
|
%% uncomment to get verbose output from test suite
|
||||||
|
%% {eunit_opts, [verbose]}.
|
||||||
|
|
||||||
|
{erl_opts, [
|
||||||
|
{i, "src"},
|
||||||
|
{src_dirs, ["src"]},
|
||||||
warn_unused_vars,
|
warn_unused_vars,
|
||||||
warn_export_all,
|
warn_export_all,
|
||||||
warn_shadow_vars,
|
warn_shadow_vars,
|
||||||
|
@ -10,14 +15,22 @@
|
||||||
warn_obsolete_guard,
|
warn_obsolete_guard,
|
||||||
strict_validation,
|
strict_validation,
|
||||||
warn_export_vars,
|
warn_export_vars,
|
||||||
warn_exported_vars]}.
|
warn_exported_vars
|
||||||
{dialyzer_opts, [{warnings, [unmatched_returns, error_handling, race_conditions, behaviours]}]}.
|
]}.
|
||||||
|
|
||||||
|
{dialyzer_opts, [{warnings, [
|
||||||
|
unmatched_returns,
|
||||||
|
error_handling,
|
||||||
|
race_conditions,
|
||||||
|
behaviours
|
||||||
|
]}]}.
|
||||||
|
|
||||||
{xref_checks, [undefined_function_calls]}.
|
{xref_checks, [undefined_function_calls]}.
|
||||||
|
|
||||||
{cover_enabled, true}.
|
{cover_enabled, true}.
|
||||||
|
|
||||||
{deps, [
|
{deps, [{
|
||||||
{'nicedecimal',
|
'nicedecimal',
|
||||||
".*",
|
".*",
|
||||||
{git, "git://github.com/talentdeficit/nicedecimal.git"}
|
{git, "git://github.com/talentdeficit/nicedecimal.git"}
|
||||||
}
|
}]}.
|
||||||
]}.
|
|
||||||
|
|
|
@ -1,11 +1,13 @@
|
||||||
%% edit eunit_test_path if you want to run your own tests, use "../" not "./" as
|
%% edit eunit_test_path if you want to run your own tests, use "../" not
|
||||||
%% rebar changes to working dir to .eunit when running tests
|
%% "./" as rebar changes working dir to .eunit when running tests
|
||||||
{eunit_compile_opts, [{d, eunit_test_path, "../test/cases"}]}.
|
{eunit_compile_opts, [{d, eunit_test_path, "../test/cases"}]}.
|
||||||
|
|
||||||
%% uncomment to get verbose output from test suite
|
%% uncomment to get verbose output from test suite
|
||||||
%% {eunit_opts, [verbose]}.
|
%% {eunit_opts, [verbose]}.
|
||||||
|
|
||||||
{erl_opts, [{i, "src"}, {src_dirs, ["src"]},
|
{erl_opts, [
|
||||||
|
{i, "src"},
|
||||||
|
{src_dirs, ["src"]},
|
||||||
warn_unused_vars,
|
warn_unused_vars,
|
||||||
warn_export_all,
|
warn_export_all,
|
||||||
warn_shadow_vars,
|
warn_shadow_vars,
|
||||||
|
@ -17,14 +19,18 @@
|
||||||
warn_obsolete_guard,
|
warn_obsolete_guard,
|
||||||
strict_validation,
|
strict_validation,
|
||||||
warn_export_vars,
|
warn_export_vars,
|
||||||
warn_exported_vars]}.
|
warn_exported_vars
|
||||||
{dialyzer_opts, [{warnings, [unmatched_returns, error_handling, race_conditions, behaviours]}]}.
|
]}.
|
||||||
|
|
||||||
|
{dialyzer_opts, [{warnings, [
|
||||||
|
unmatched_returns,
|
||||||
|
error_handling,
|
||||||
|
race_conditions,
|
||||||
|
behaviours
|
||||||
|
]}]}.
|
||||||
|
|
||||||
{xref_checks, [undefined_function_calls]}.
|
{xref_checks, [undefined_function_calls]}.
|
||||||
|
|
||||||
{cover_enabled, true}.
|
{cover_enabled, true}.
|
||||||
|
|
||||||
{deps, [
|
{deps, [{'meck', ".*", {git, "git://github.com/eproxus/meck.git"}}]}.
|
||||||
{'meck',
|
|
||||||
".*",
|
|
||||||
{git, "git://github.com/eproxus/meck.git"}
|
|
||||||
}
|
|
||||||
]}.
|
|
Loading…
Add table
Add a link
Reference in a new issue