Skip to content

README.md

Latest commit

 

History

History
36 lines (25 loc) · 1.86 KB

README.md

File metadata and controls

36 lines (25 loc) · 1.86 KB
Raw

npm version Join the chat at https://gitter.im/satzbeleg/community

bwsample-js

Javascript implementation of bwsample to run in a browser.

Important Note

Variable and function names do not comply with JS conventions (e.g. camel case). We kept the same variable and function names as in the Python package bwsample.

We are using

  • snake_case: variable names
  • kebab-case: JSON keys
  • camelCase: function names, class names

Appendix

Misc commands

  • Login into yarn: yarn login
  • Publish the package: yarn publish

Support

Please open an issue for support.

Contributing

Please contribute using Github Flow. Create a branch, add commits, and open a pull request.

Acknowledgements

This work was funded by the Deutsche Forschungsgemeinschaft (DFG, German Research Foundation) - 433249742. Project duration: 2020-2023.

Maintenance

  • till 31.Aug.2023 (v0.1.5) the code repository was maintained within the DFG project 433249742
  • since 01.Sep.2023 (v0.2.0) the code repository is maintained by @ulf1.

Citation

Please cite the peer-reviewed JOSS paper DOI when using this software for any purpose. Please note that the Javascript version of bwsample was not subject to the JOSS review.