Commit Graph

12 Commits

Author SHA1 Message Date
Julian Amann
ea90517def Fix spelling mistake (#677)
Summary:
Fix spelling mistake

Pull Request resolved: https://github.com/facebook/sapling/pull/677

Reviewed By: MichaelCuevas

Differential Revision: D47763201

Pulled By: evangrayk

fbshipit-source-id: 03fe0de5955e9bda38019e9c5b2039bb92747b1b
2023-07-25 12:33:29 -07:00
Durham Goode
f2c5fdb769 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
2022-11-15 09:02:28 -08:00
Durham Goode
c08291556a website: update github main readme
Summary:
This updates the main readme in a few ways:

- Renames EdenSCM to Sapling
- Drops references to building Mononoke and EdenFS.
- Adds some extra text to say Mononoke and EdenFS are not publicly supported
  yet.
- Adds some links to the main Sapling website and to the ISL documentation.

Reviewed By: quark-zju

Differential Revision: D41275627

fbshipit-source-id: de72ad2025ee5d24a8218586a32c6e70919c6cde
2022-11-15 08:03:19 -08:00
Alex Hornby
5056cc1288 mononoke: README.md update
Summary:
Removed the line where we say Mononoke doesn't build, as it does!

Added links to the few .md docs that Mononoke has in repo

Reviewed By: mzr

Differential Revision: D34373614

fbshipit-source-id: 1bec3f4cf4ed158e4698b02a871d1b41d236cd1f
2022-02-21 02:23:21 -08:00
Alex Hornby
ac2e8ad53f eden: update README.md to reference getdeps.py for builds
Summary: Lets document that the way to build OSS eden_scm, edenFS and Mononoke is via getdeps.py

Reviewed By: chadaustin

Differential Revision: D34148404

fbshipit-source-id: 89a53d9b7263bdeb56af4e2cff6873aae5337038
2022-02-11 01:42:04 -08:00
Genevieve Helsel
d85de88946 include oss installation instructions for ubuntu
Summary: I spent a good chunk of time installing eden on a fresh ubuntu vm from github, so I kept track of all of the packages that I needed to end up installing. users can install these before attempting to run the `build.sh` script in order to make sure all dependencies are there. Some of these manifested in non-obvious error messages. I'm sure as time goes on these dependencies might change a bit, but I think its a good starting point for anyone and should save a few hours of headache.

Reviewed By: chadaustin

Differential Revision: D22716112

fbshipit-source-id: 49232232a8707ef59c47487fdcc0cb41afc702e8
2020-07-24 11:34:17 -07:00
Adam Simpkins
145320fe96 check in some high-level design documentation for EdenFS
Summary:
This checks in some design documents based on the "EdenFS Internals"
presentation that I've given internally a few times.

Reviewed By: wez

Differential Revision: D21519530

fbshipit-source-id: 3f79d38e8ccf994b2ef303d491809a91fa5b6d95
2020-05-15 18:08:47 -07:00
Adam Simpkins
fd2791377c update the top-level README file
Summary:
Now that the `eden` CLI code, Mononoke, and EdenFS are all available in the
same github repository, update the top-level README to describe all 3 of these
components.

Reviewed By: JoelMarcey

Differential Revision: D20688288

fbshipit-source-id: 40110ba05f16dedbcb6ab2a8e56eef7da16bb567
2020-03-30 19:27:54 -07:00
Adam Simpkins
03d66463bc Add CODE_OF_CONDUCT.md and reference the LICENSE file in README.md
Summary:
Add a code of conduct file and explicitly link to the license in the README
file.

Reviewed By: chadaustin

Differential Revision: D15105845

fbshipit-source-id: 482c9e94f5d3eb389977b5f84dca320c94b4bd88
2019-04-26 14:38:27 -07:00
Adam Simpkins
3eb238ea21 update README.md
Summary:
Update Eden's README.md file with a better description and with build
instructions.

Reviewed By: strager

Differential Revision: D12813739

fbshipit-source-id: 4c69cd63159cc01c514da4e46da45f27eaa8ae52
2018-10-30 13:35:40 -07:00
Michael Bolin
d12970932a Fix a typo in Eden's README.md.
Reviewed By: simpkins

Differential Revision: D3295624

fbshipit-source-id: 18878cce5c5eb4dbcc96918a48261876e1eb6e68
2016-05-13 09:32:03 -07:00
Michael Bolin
6f00967e51 Initial import: README.md only. 2016-05-12 12:22:30 -07:00