From f2c5fdb769008a978bc821a603af94add2dbaf2c Mon Sep 17 00:00:00 2001 From: Durham Goode Date: Tue, 15 Nov 2022 09:02:28 -0800 Subject: [PATCH] website: downplay Mononoke and EdenFS in readme.md Summary: The current Github main page gives equal footing to Mononoke and EdenFS, even though they are not ready for open source usage yet. Let's make the lack of support explicit for EdenFS (it already was for Mononoke), and shrink the headers to downplay their current footing with respect to the Sapling CLI. Reviewed By: quark-zju Differential Revision: D41309064 fbshipit-source-id: 7a38edd926571dbff5104f1bbe65bf5a7cfa500e --- README.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 965ea3c915..dc67daa1d2 100644 --- a/README.md +++ b/README.md @@ -27,7 +27,7 @@ scale with the number of files in use by a developer, and not with the size of the repository itself. This enables fast, performant developer experiences even in massive repositories with millions of files and extremely long commit histories. -# Sapling CLI +### Sapling CLI The Sapling CLI, `sl`, was originally based on [Mercurial](https://www.mercurial-scm.org/), and shares various aspects of the UI @@ -35,17 +35,20 @@ and features of Mercurial. The CLI code can be found in the `eden/scm` subdirectory. -# Mononoke +### Mononoke [Mononoke](eden/mononoke/README.md) is the server-side component of Sapling SCM. While it is used in production within Meta, it currently does not build in an open source context and is not yet supported for external usage. -# EdenFS +### EdenFS EdenFS is a virtual file system for managing Sapling checkouts. +While it is used in production within Meta, it currently does not build in an +open source context and is not yet supported for external usage. + EdenFS speeds up operations in large repositories by only populating working directory files on demand, as they are accessed. This makes operations like `checkout` much faster, in exchange for a small performance hit when first