1
1
mirror of https://github.com/anoma/juvix.git synced 2024-12-15 01:52:11 +03:00
juvix/README.org

97 lines
4.2 KiB
Org Mode
Raw Normal View History

* Juvix
2022-03-28 18:32:09 +03:00
#+begin_html
<a href="https://github.com/anoma/juvix/actions/workflows/ci.yml">
<img alt="CI status" src="https://github.com/anoma/juvix/actions/workflows/ci.yml/badge.svg" />
</a>
#+end_html
#+begin_html
<a href="https://github.com/anoma/juvix/tags">
<img alt="" src="https://img.shields.io/github/v/release/anoma/juvix?include_prereleases" />
</a>
#+end_html
2022-03-28 18:32:09 +03:00
#+begin_html
<a href="https://github.com/anoma/juvix/blob/main/LICENSE">
2022-03-28 18:32:09 +03:00
<img alt="LICENSE" src="https://img.shields.io/badge/license-GPL--3.0--only-blue.svg" />
</a>
#+end_html
#+begin_html
<a href="https://github.com/anoma/juvix/actions/workflows/pages/pages-build-deployment"><img
src="https://github.com/anoma/juvix/actions/workflows/pages/pages-build-deployment/badge.svg"
alt="pages-build-deployment" /></a>
2022-03-28 18:32:09 +03:00
#+end_html
2022-04-08 14:35:04 +03:00
#+begin_html
<a href="https://github.com/anoma/juvix">
<img align="right" width="300" height="300" alt="Juvix Mascot" src="assets/seating-mascot.051c86a.svg" />
2022-04-08 14:35:04 +03:00
</a>
#+end_html
2022-03-25 20:10:17 +03:00
** Description
Juvix is a research programming language created by [[https://heliax.dev/][Heliax]] as a first step toward creating more robust and reliable alternatives for formally verified smart contracts than existing languages. The Juvix language is constantly evolving, open-source, functional, and statically typed with special support for compiling [[https://anoma.network/blog/validity-predicates/][validity predicates]] to the =C= language, which can be deployed to various distributed ledgers including [[https://anoma.net/][Anoma]].
The Juvix programming language allows developers to write programs with a high degree of assurance that they will meet specific standards. This is due to the fact that several static analyses are performed during compilation, including, for example, scope, termination, arity, and type checking. As a result, functional programs, especially validity predicates, can be written with greater confidence that they will be free of runtime errors.
The language features:
2022-03-25 20:10:17 +03:00
- unicode syntax
- parametric polymorphism
- inductive and parametric data types
- higher-order functions
- implicit arguments
- holes in programs
- axioms for non-computable terms
2022-03-25 20:10:17 +03:00
Additionally, the foreign and compile blocks syntax enable developers to compile a program to different backends including the =C= language. The Juvix module system further permits splitting programs into several modules to build libraries which can be later documented by generating HTML files based on the codebase, see for example, [[https://anoma.github.io/juvix-stdlib/][the Juvix standard library's website]]. For futher details, please refer to [[https://anoma.github.io/juvix/][the Juvix book]] which icludes our [[https://anoma.github.io/juvix/introduction/changelog.html][latest updates]].
2022-03-25 20:10:17 +03:00
[[https://github.com/anoma/juvix/tree/main/examples/milestone][See a few examples of Juvix programs]].
2022-03-25 20:10:17 +03:00
** Quick Start
To install Juvix, you can download its sources using
2022-03-25 20:10:17 +03:00
[[http://git-scm.com/][Git]] from the
[[https://github.com/anoma/juvix.git][Github repository]]. Then, the
program can be downloaded and installed with the following commands. You
2022-04-08 14:35:04 +03:00
will need to have [[https://haskellstack.org][Stack]] installed.
2022-03-25 20:10:17 +03:00
#+begin_src shell
git clone --recursive https://github.com/anoma/juvix.git
cd juvix
stack install
2022-03-25 20:10:17 +03:00
#+end_src
If the installation succeeds, you must be able to run the =juvix=
2022-03-25 20:10:17 +03:00
command from any location. To get the complete list of commands, please
run =juvix --help=.
2022-03-25 20:10:17 +03:00
** Usage Example
In the following example a Juvix file is compiled using the C backend. The
result is compiled to WASM using [[https://llvm.org][Clang]] and then executed using [[https://wasmer.io][wasmer]].
NB: Set the =WASI_SYSROOT_PATH= environment variable to the root of the WASI
sysroot. See [[https://anoma.github.io/juvix/getting-started/dependencies.html][Installing dependencies]] for instructions on how to install the
sysroot.
#+begin_src shell
cd tests/positive/MiniC/HelloWorld
juvix compile Input.juvix
wasmer Input.wasm
#+end_src
You should see the output: =hello world!=
** The Juvix Book
The Juvix language and related tools are documented in [[https://anoma.github.io/juvix/][the Juvix book]].
2022-03-25 20:10:17 +03:00
** Community
We would love to hear what you think of Juvix! Join us on
[[https://discord.gg/vEQappb7wG][the Anoma Discord]].