TerribleCodeClub
/
romulus-js
12
0
Fork 0
Code Issues 2 Pull Requests Projects 1 Releases 1 Wiki Activity
romulus-js/README.md

1.0 KiB
Raw Blame History

Romulus-JS

An implementation of the Romulus-M cryptography specification.

Build

To build the Romulus-JS library, first clone this repository.

Run the following commands from the root of the repository:

$ npm install
$ npm run build

The build output will be saved to the lib directory.

Visual Studio Code

This repository contains the necessary configuration files to debug, test and build Romulus-JS using only Visual Studio Code.

Run the build task (Ctrl+Shift+B or ⇧⌘B) to automatically compile the Typescript source files in the background.

Debug and test instructions for Visual Studio Code coming soon.

Contribution

JavaScript Style Guide

This library uses ts-standard, based on JavaScript Standard Style. Please ensure all contributions are ts-standard compliant before submitting a pull request.