Skip to content

Commit

Permalink
Rename the Contribution page into Build from Source
Browse files Browse the repository at this point in the history
Summary: I often look for the instructions to build from source, and can never find it because it's in the "contribution" page. Let's just rename that page.

Reviewed By: anwesht

Differential Revision: D59321280

fbshipit-source-id: ff49e5bd4eaf5f0d7558c59c9e96ecf65037b683
  • Loading branch information
arthaud authored and facebook-github-bot committed Jul 3, 2024
1 parent 8304a13 commit f36edd7
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 11 deletions.
Original file line number Diff line number Diff line change
@@ -1,18 +1,16 @@
---
id: contribution
title: Contribution
sidebar_label: Contribution
id: build-from-source
title: Build from Source
sidebar_label: Build from Source
---

This documentation aims to help you become an active contributor to Mariana Trench.
This documentation aims to help you build Mariana Trench from source and run the tests.

## Building From Source

### Support
## Supported Platforms

Mariana Trench is currently supported on **macOS** (tested on *Big Sur 11.4*) and **Linux** (tested on *Ubuntu 20.04 LTS*).

### Dependencies
## Dependencies

Below is a list of the required dependencies. Most of them can be installed with **[Homebrew](https://brew.sh/)**.

Expand All @@ -29,6 +27,8 @@ Below is a list of the required dependencies. Most of them can be installed with
* Android SDK (Optional)
* Redex (master)

## Building and Installing

### Install all dependencies with Homebrew

First, follow the instructions to install **[Homebrew](https://brew.sh/)** on your system.
Expand Down Expand Up @@ -131,7 +131,7 @@ $ python scripts/setup.py \
install
```

## Development
## Testing during development

If you are making changes to Mariana Trench, you can use the `mariana-trench` wrapper inside the build directory:
```shell
Expand All @@ -148,7 +148,7 @@ Note that you will need to install all python dependencies:
$ pip install pyre_extensions fb-sapp
```

## Run the tests
## Running the tests

To run the tests after building Mariana Trench, use:
```shell
Expand Down
2 changes: 1 addition & 1 deletion documentation/website/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ module.exports = {
fbInternalOnly('fb/testing-diffs'),
],
'Developer Guide': [
fbContent({external: 'contribution'}),
fbContent({external: 'build-from-source'}),
fbInternalOnly('fb/developer-getting-started'),
fbInternalOnly('fb/running-tests'),
fbInternalOnly('fb/inspecting-an-apk'),
Expand Down

0 comments on commit f36edd7

Please sign in to comment.