Gitiles
Code Review Sign In
gerrit-dev.monogon.dev / monogon / 6920c47bdd3cd6a0f78b4815bc6378c98c9d159e
commit6920c47bdd3cd6a0f78b4815bc6378c98c9d159e[log] [tgz]
authorLeopold Schabel <leo@monogon.tech>Sat Aug 10 19:40:35 2024 +0200
committerLeopold Schabel <leo@monogon.tech>Mon Aug 19 13:11:09 2024 +0000
treea0cae7630c3e3e3250660e25c4514b12c02a3092
parentcc27faac73b1bff4b0d31ffacb0d938022db75ea [diff]
Document top-level directories

Change-Id: I52889e4823cbeb841c7dc9da12b5fe4c6a79d663
Reviewed-on: https://review.monogon.dev/c/monogon/+/3310
Tested-by: Jenkins CI
Reviewed-by: Lorenz Brun <lorenz@monogon.tech>
7 files changed
tree: a0cae7630c3e3e3250660e25c4514b12c02a3092
  1. .github/
  2. build/
  3. cloud/
  4. go/
  5. intellij/
  6. metropolis/
  7. net/
  8. osbase/
  9. third_party/
  10. tools/
  11. version/
  12. .bazelignore
  13. .bazelproject
  14. .bazelrc
  15. .bazelrc.ci
  16. .bazelrc.sandboxroot
  17. .bazelversion
  18. .git-ignore-revs
  19. .gitignore
  20. BUILD.bazel
  21. CODING_STANDARDS.md
  22. go.mod
  23. go.MODULE.bazel
  24. go.sum
  25. LICENSE
  26. MODULE.bazel
  27. MODULE.bazel.lock
  28. oci.MODULE.bazel
  29. README.md
  30. rust.MODULE.bazel
  31. SETUP.md
  32. shell.nix
  33. third_party.MODULE.bazel
  34. WORKSPACE
README.md

Monogon Monorepo

This is the main repository containing the source code for the Monogon Platform.

This is pre-release software - take a look, and check back later! In the meantime, join us on Matrix (#monogon-os-community:matrix.org) or Discord.

Environment

Our build environment is self-contained and requires only minimal host dependencies:

  • A Linux machine or VM.
  • Bazelisk >= v1.15.0 (or a working Nix environment).
  • A reasonably recent kernel with user namespaces enabled.
  • Working KVM with access to /dev/kvm (if you want to run tests).

Our docs assume that Bazelisk is available as bazel on your PATH.

Refer to SETUP.md for detailed instructions.

Monogon OS

The source code lives in //metropolis (Metropolis is the codename of Monogon OS).

See the //metropolis/README.md for a developer quick start guide, or see the Monogon OS Handbook for user documentation.