anoma/juvix
1
1
Fork 0
mirror of https://github.com/anoma/juvix.git synced 2024-12-15 01:52:11 +03:00
Code Issues Projects Releases Wiki Activity
c9b0193fb4
juvix/README.org
Jonathan Prieto-Cubides eaad611bbf [ CI ] Add Haskell Github Action with Stack test and ormolu check
2022-04-04 15:55:15 +02:00

2.6 KiB
Raw Blame History

MiniJuvix

<a href="https://github.com/heliaxdev/minijuvix/blob/main/LICENSE"> <img alt="LICENSE" src="https://img.shields.io/badge/license-GPL--3.0--only-blue.svg" /> </a>

<a href="https://github.com/heliaxdev/MiniJuvix/actions/workflows/ci.yml"> <img alt="CI status" src="https://github.com/heliaxdev/MiniJuvix/actions/workflows/ci.yml/badge.svg" /> </a>

Description

MiniJuvix is a dependently functional programming language for writing efficient formally-verified validity predicates, which can be deployed to various distributed ledgers. This is a software released for experimentation and research purposes only. No warranty is provided or implied.

MiniJuvix addresses many issues that we have experienced while trying to write and deploy decentralised applications present in the ecosystem of smart-contracts:

  • the difficulty of adequate program verification,
  • the ceiling of compositional complexity,
  • the illegibility of execution costs, and
  • the lock-in to particular backends.

Quick Start

To install MiniJuvix, you can download its sources using Git from the Github repository. Then, the program can be downloaded and installed with the following commands. You will need to have installed Stack.

   $ git clone https://github.com/heliaxdev/minijuvix.git
   $ cd minijuvix
   $ stack install

If the installation succeeds, you must be able to run the minijuvix command from any location. To get the complete list of commands, please run minijuvix --help.

  • To test everything works correctly, you can run the following command:
  $ stack test

Emacs mode

There is an Emacs mode available for MiniJuvix. Currently, it supports syntax highlighting for well-scoped modules.

To install it add the following lines to your Emacs configuration file:

(push "/path/to/minijuvix/minijuvix-mode/" load-path)
(require 'minijuvix-mode)

Make sure that minijuvix is installed in your PATH.

The MiniJuvix major mode will be activated automatically for .mjuvix files.

Keybindings

Key Function Name Description
C-c C-l minijuvix-load Runs the scoper and adds semantic syntax highlighting

Community

We would love to hear what you think of MiniJuvix! Join us on Discord