urbit/vere
1
1
Fork 0
mirror of https://github.com/urbit/vere.git synced 2024-09-17 14:47:29 +03:00
Code Issues Packages Projects Releases Wiki Activity
b339b5067a
vere/README.md
Peter McEvoy b339b5067a Build with bazel on linux-x86_64 (#10)
2023-01-09 13:46:48 -05:00

3.3 KiB
Raw Blame History

Urbit Runtime

Urbit is a personal server stack built from scratch. This repository contains Urbit's runtime environment, the lowest layer of the Urbit stack, which includes the Nock virtual machine, I/O drivers, event log, and snapshotting system.

Getting Started

For basic Urbit usage instructions, head over to urbit.org. For a high-level overview of the salient aspects of Urbit's architecture, visit developers.urbit.org. You might also be interested in joining the urbit-dev mailing list.

Packages

Urbit's runtime is broken down into a few separate layers, each of which is defined in its own package:

  • pkg/c3: A set of basic utilities for writing Urbit's style of C.
  • pkg/ent: A cross-platform wrapper for getentropy(2).
  • pkg/urcrypt: A standardized interface for calling various cryptographic functions used in the Urbit runtime.
  • pkg/ur: An implementation of jam and cue, Urbit's bitwise noun serialization and deserialization algorithms, respectively.
  • pkg/noun: The Nock virtual machine and snapshotting system.
  • pkg/vere: The I/O drivers, event log, and main event loop.

Build

We use bazel to build Urbit's runtime. We support the following platforms:

  • darwin-arm64 (macOS running Apple Silicon)
  • darwin-x86_64 (macOS running Intel silicon)
  • linux-arm64
  • linux-x86_64
  • openbsd-x86_64
  • mingw-x86_64

To build the urbit binary, the primary artifact of this repository, ensure that you're on a supported platform and that you have an up-to-date version of bazel, and then run:

$ bazel build :urbit

The build will take a while since bazel has to download and build from source all of urbit's third-party dependencies.

To run the just-built urbit binary, run:

$ bazel-bin/pkg/vere/urbit ...

Or, to save yourself a few keystrokes, create a symlink to the urbit binary in the root of the repository:

$ ln -s bazel-bin/pkg/vere/urbit urbit
$ ./urbit ...

To run all runtime tests, run:

$ bazel test //...

or, to run a specific test, say pkg/noun/hashtable_tests.c, run:

$ bazel test //pkg/noun:hashtable_tests

If you're interested in digging into the details of the build system, check out WORKSPACE.bazel, BUILD.bazel, bazel/, and the multiple BUILD.bazel files in pkg/.

Contributing

Contributions of any form are more than welcome. Please take a look at our contributing guidelines for details on our git practices, coding styles, how we manage issues, and so on.