Skip to content

Commit

Permalink
Improved the README a tad.
Browse files Browse the repository at this point in the history
  • Loading branch information
artob committed Sep 18, 2020
1 parent 29f9df2 commit 0587a26
Showing 1 changed file with 26 additions and 7 deletions.
33 changes: 26 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,20 @@ We are working on building release binaries for Windows, macOS, and Linux.
They will be available here soon.

In the meantime, if you wish to try out Sworn, you will need to build it from
source code, which entails setting up an OCaml development environment.
source code yourself, which entails setting up an OCaml development
environment.

For the impatient and adventurous, reserve an hour of time and see further
down in this document for the particulars.
For the impatient and adventurous, reserve at least an hour of time and see
further down in this document for the particulars.

## Usage

To view Sworn's built-in man page, just run:

```bash
sworn --help
```

### Compiling for SmartWeave

To compile the Clarity [`counter.clar`] example contract, run:
Expand All @@ -42,8 +49,9 @@ sworn -o counter.js counter.clar

### Compiling to WebAssembly

There is experimental support for compiling to WebAssembly. Both the textual
representation (`.wat`) and binary bytecode (`.wasm`) are supported:
There is preliminary and experimental support for compiling to [WebAssembly].
Both the textual representation (`.wat`) and binary bytecode (`.wasm`) format
are supported:

```bash
sworn -t wat counter.clar
Expand All @@ -68,7 +76,7 @@ The following baseline tooling is required in order to build Sworn:

- [Docker](https://docs.docker.com/get-docker/) (for release builds only)

We recommend you *don't* install OCaml from a package manager.
We would recommend you *don't* install OCaml from a package manager.

Rather, [get set up with OPAM](https://opam.ocaml.org/doc/Install.html) and
then let OPAM install the correct version of OCaml as follows:
Expand Down Expand Up @@ -110,7 +118,7 @@ Sworn:
- [Wasm](https://opam.ocaml.org/packages/wasm/)
for WebAssembly code generation

These aforementioned dependencies are best installed via OPAM:
These aforementioned dependencies are all best installed via OPAM:

```bash
opam install alcotest cmdliner cppo iso8601 ocolor sexplib wasm
Expand All @@ -128,13 +136,24 @@ sworn --help

```bash
git clone https://github.com/weavery/sworn.git

cd sworn

dune build

sudo install _build/default/bin/sworn/sworn.exe /usr/local/bin/sworn
```

## Acknowledgments

We thank [Arweave] and [Blockstack] for sponsoring the development of Sworn,
and Blockstack and [Algorand] for having developed the Clarity language.

[Algorand]: https://algorand.com
[Arweave]: https://arweave.org
[Blockstack]: https://blockstack.org
[Clarity]: https://clarity-lang.org
[SmartWeave]: https://github.com/ArweaveTeam/SmartWeave
[WebAssembly]: https://webassembly.org

[`counter.clar`]: https://github.com/clarity-lang/overview/blob/master/counter.clar

0 comments on commit 0587a26

Please sign in to comment.