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

30 lines
1.0 KiB
Markdown
Raw Normal View History

Boilerplate TS project.
2022-01-29 10:57:04 +00:00
# Romulus-JS
Initial commit
2022-01-29 10:31:20 +00:00
Boilerplate TS project.
2022-01-29 10:57:04 +00:00
An implementation of the Romulus-M cryptography specification.
## Build
Project setup
2022-01-29 11:33:05 +00:00
To build the Romulus-JS library, first clone this repository.
Run the following commands from the root of the repository:
```bash
$ npm install
$ npm run build
```
The build output will be saved to the `lib` directory.
Boilerplate TS project.
2022-01-29 10:57:04 +00:00
### 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](https://cdn.rawgit.com/standard/standard/master/badge.svg)](https://github.com/standard/standard)
This library uses [ts-standard](https://github.com/standard/ts-standard), based on [JavaScript Standard Style](https://standardjs.com/rules.html). Please ensure all contributions are ts-standard compliant before submitting a pull request.