Skip to content
This repository has been archived by the owner on May 31, 2020. It is now read-only.

Commit

Permalink
Merge pull request #565 from abonie/creating_module_docs
Browse files Browse the repository at this point in the history
Update information on creating new modules
  • Loading branch information
freakboy3742 committed Jun 11, 2017
2 parents 9ebacd1 + cdbc45c commit ab9b2f6
Showing 1 changed file with 11 additions and 6 deletions.
17 changes: 11 additions & 6 deletions docs/usage/modules-and-tests.rst
Original file line number Diff line number Diff line change
@@ -1,12 +1,17 @@
Adding a module and testing it
==============================

To create a module
------------------
Modules in Batavia can be implemented either natively, in JavaScript or in supported subset of Python.

Add the module path, in alphabetic order, to:
a) Makefile (on BASE_FILES and BASE_FILES_WIN);
b) testserver/testbed.html.
To create a native module
-------------------------

Add the module path to module.exports in batavia/modules.js.

To create a module in Python
----------------------------

Add module to compile_stdlib.py

To create a test
----------------
Expand All @@ -23,4 +28,4 @@ On the Batavia directory:
$ python setup.py test -s tests.modules.NAME_OF_MODULE

For instance, to test the base_64 module:
$ python setup.py test -s tests.modules.test_base64
$ python setup.py test -s tests.modules.test_base64

0 comments on commit ab9b2f6

Please sign in to comment.