If you have a question about Scanamo there is a Gitter channel to try and answer it. Suggestions on how to improve the documentation are very welcome.
Feel free to open an issue if you notice a bug or have an idea for a feature.
Pull requests are gladly accepted. Scanamo follows a standard fork and pull model for contributions via GitHub pull requests.
Scanamo uses a standard SBT build. If you
have SBT installed you can just run the test
command from the SBT prompt
to compile Scanamo and run its tests.
Most, though not all of Scanamo's tests are from examples in the scaladoc,
or README.md
, which are turned into tests by
sbt-doctest.
The website is built using sbt-microsites. To check documentation changes:
- run
makeMicrosite
from the root of SBT - run
jekyll serve --incremental --baseurl /scanamo
fromdocs/target/site
- Load http://127.0.0.1:4000/scanamo/