https://github.com/funkywork/yourbones
A companion library for writing applications on Tezos (in OCaml)
https://github.com/funkywork/yourbones
Last synced: 3 months ago
JSON representation
A companion library for writing applications on Tezos (in OCaml)
- Host: GitHub
- URL: https://github.com/funkywork/yourbones
- Owner: funkywork
- License: mit
- Created: 2023-02-06T21:56:57.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-01-29T11:45:11.000Z (about 2 years ago)
- Last Synced: 2024-01-29T14:13:44.224Z (about 2 years ago)
- Language: OCaml
- Size: 875 KB
- Stars: 15
- Watchers: 4
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome - funkywork/yourbones - A companion library for writing applications on Tezos (in OCaml) (<a name="OCaml"></a>OCaml)
README
# yourbones
> **Warning** _Yourbones_ is still _Work In Progress_.
A companion library for writing applications on Tezos (in OCaml). The name is
arguably funny to anyone who speaks French. Indeed, `your bones` can be
translated as `tes os` in the language of **Molière**, which sounds like
`tezos`... hence the giggle.
## Setting up the development environment
Setting up a development environment is quite common. We recommend setting up a
local switch to collect dependencies locally. Here are the commands to enter to
initiate the environment:
```shellsession
opam update
opam switch create . ocaml-base-compiler.5.0.0 --deps-only -y
eval $(opam env)
```
After initializing the switch, you can collect the development and project
dependencies using `make`:
```shellsession
make dev-deps
make deps
```
Now you should be able to easily start contributing to **Yourbones**.
> **Note** If you are not using [GNU/Make](https://www.gnu.org/software/make/)
> (or equivalent), you can refer to the [Makefile](Makefile) and observe the
> `dev-deps` and `deps` rules to get the commands to run.