An implementation of the Urbit runtime
Go to file
2023-01-09 13:54:11 -05:00
.github/workflows Merge pull request #6190 from urbit/m/min-mingw 2023-01-05 10:13:09 -08:00
bazel Build with musl instead of glibc on Linux (#27) 2023-01-09 13:54:11 -05:00
doc/spec docs: remove http-ports.txt 2022-03-04 19:36:26 -06:00
pkg Build with musl instead of glibc on Linux (#27) 2023-01-09 13:54:11 -05:00
.bazelrc Build with bazel on linux-arm64 (#16) 2023-01-09 13:46:53 -05:00
.gitignore Replace Xcode-specific sys_includes path in clang-macos-arm64 (#24) 2023-01-09 13:50:20 -05:00
BUILD.bazel Build with musl instead of glibc on Linux (#27) 2023-01-09 13:54:11 -05:00
CONTRIBUTING.md Build with bazel on linux-x86_64 (#10) 2023-01-09 13:46:48 -05:00
DOCKER.md docker: update documentation 2021-04-25 12:02:56 -04:00
INSTALL.md Build with musl instead of glibc on Linux (#27) 2023-01-09 13:54:11 -05:00
LICENSE.txt Restore toplevel LICENSE.txt file. 2020-01-28 13:24:39 -08:00
MAINTAINERS.md Merge remote-tracking branch 'origin/jm/homebase' into philip/tomb 2022-05-14 20:46:09 -07:00
Makefile build: removes herb from top-level Makefile, shell.nix 2022-06-03 14:40:08 -04:00
README.md Build with musl instead of glibc on Linux (#27) 2023-01-09 13:54:11 -05:00
WORKSPACE.bazel Build with musl instead of glibc on Linux (#27) 2023-01-09 13:54:11 -05:00

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

See INSTALL.md.

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.