Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Build out Contribute index with download instructions and descriptions of primary directories #1076

Merged
merged 6 commits into from
Mar 30, 2022
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Update index.md
Identify, link to, and summarize contents of primary directories
  • Loading branch information
Clay-Mysten authored Mar 25, 2022
commit f58da2ee17cbaadd63d487e4f4154bebf6217bdf
14 changes: 7 additions & 7 deletions doc/src/contribute/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,20 +20,20 @@ Simply edit the file in question and generate a pull request. We will get back t

## Download and learn Sui?
Clay-Mysten marked this conversation as resolved.
Show resolved Hide resolved

In order to obtain source code for the game, let us clone the Sui
repository to the desired directory:
In order to obtain the Sui source code, clone the Sui repository:

```shell
git clone https://github.com/MystenLabs/sui.git
```

The primary directories are:
Clay-Mysten marked this conversation as resolved.
Show resolved Hide resolved

* [sui](https://github.com/MystenLabs/sui/tree/main/sui) -
* [sui_programmability](https://github.com/MystenLabs/sui/tree/main/sui_programmability) - examples and games for testing and reuse.
* sui_core
* sui_types
* explorer -
* [sui](https://github.com/MystenLabs/sui/tree/main/sui) - the Sui binaries (`wallet`, `sui-move`, and more)
* [sui_programmability](https://github.com/MystenLabs/sui/tree/main/sui_programmability) - games and other examples for testing and reuse
Clay-Mysten marked this conversation as resolved.
Show resolved Hide resolved
* [sui_core](https://github.com/MystenLabs/sui/tree/main/sui_core) - authority server and Sui Gateway
* [sui_types](https://github.com/MystenLabs/sui/tree/main/sui_types) - coins, gas, and other object types
* [explorer](https://github.com/MystenLabs/sui/tree/main/explorer) - chain explorer for the Sui network
Clay-Mysten marked this conversation as resolved.
Show resolved Hide resolved
* [network_utils](https://github.com/MystenLabs/sui/tree/main/network_utils) - networking utilities and related unit tests

## Send pull requests

Expand Down