Skip to content

Commit

Permalink
Update quickstart
Browse files Browse the repository at this point in the history
  • Loading branch information
hkalodner committed Aug 28, 2019
1 parent 396cae1 commit ff6db68
Show file tree
Hide file tree
Showing 4 changed files with 44 additions and 38 deletions.
61 changes: 26 additions & 35 deletions docs/Developer_Quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,61 +17,52 @@ read the [white paper](https://offchainlabs.com/arbitrum.pdf)!**
Follow the instructions for supported operating systems or use the comprehensive
list of dependencies.

### MacOS
### 1. Install python3 and docker:

1. Install python3, nodejs, & docker using [Homebrew](https://brew.sh/):
#### MacOS

```bash
brew install python3 node@8 docker docker-compose
brew unlink node
brew link --force --overwrite node@8
brew cask install docker
open -a Docker
```
Using [Homebrew](https://brew.sh/):

```bash
brew install python3 docker docker-compose
brew cask install docker
open -a Docker
```

Once the Docker app appears in the menu bar, wait until the yellow light turns
green (no need to log into Docker). Also check that node version 8 is installed
green (no need to log into Docker). Also check that node version 10 is installed
correctly by running `node -v`.

2. Change npm's default directory:
If you have not installed any npm global packages before,
[change npm's default directory](https://docs.npmjs.com/resolving-eacces-permissions-errors-when-installing-packages-globally)
with the following commands:

```bash
mkdir ~/.npm-global
npm config set prefix '~/.npm-global'
echo $'# npm\nexport PATH="~/.npm-global/bin:$PATH"' >> ~/.bash_profile
source ~/.bash_profile
```

3. Install truffle and yarn

```bash
npm install -g truffle ganache-cli yarn
```

### Ubuntu 18.04
#### Ubuntu 18.04

Install python3, nodejs, docker, truffle, and yarn:
Using apt:

```bash
sudo apt-get update
sudo apt-get install -y python3 python3-pip nodejs npm docker docker-compose
sudo npm install -g truffle ganache-cli yarn
sudo apt update
sudo apt install -y python3 python3-pip docker docker-compose
```

> Docker [can be used without sudo](https://docs.docker.com/install/linux/linux-postinstall/)
> to give permissions "equivalent to the `root` user". See [the security warning](https://docs.docker.com/engine/security/security/#docker-daemon-attack-surface).
### 2. Install yarn and truffle

```bash
touch ~/.bashrc
curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.34.0/install.sh | bash
curl -o- -L https://yarnpkg.com/install.sh | bash
nvm install 10.16.3
. ~/.bashrc
yarn global add ganache-cli truffle
```

### Full List

Here are the important dependencies in case you are not running on a supported OS:

- [docker](https://github.com/docker/docker-ce/releases) and
[docker-compose](https://github.com/docker/compose/releases)
- [node and npm](https://nodejs.org/en/)
- [node](https://nodejs.org/en/)
- [python3 and pip3](https://www.python.org/downloads/)
- [truffle](https://truffleframework.com/docs/truffle/getting-started/installation)
- [ganache](https://www.npmjs.com/package/ganache-cli)
Expand Down
3 changes: 1 addition & 2 deletions packages/arb-avm-cpp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Arbitrum technologies are patent pending. This repository is offered under the Apache 2.0 license. See LICENSE for details.

## Bulding, testing, and running
## Bulding and testing

```bash
mkdir release
Expand All @@ -12,7 +12,6 @@ conan install ..
cmake .. -DCMAKE_BUILD_TYPE=Release
cmake --build .
ctest .
./app/avm_runner contract.ao inbox.dat
```

## Formatting code
Expand Down
17 changes: 17 additions & 0 deletions packages/arb-avm-cpp/utils/bigint_utils.cpp
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
/*
* Copyright 2019, Offchain Labs, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

#include "bigint_utils.hpp"
1 change: 0 additions & 1 deletion packages/arb-provider-go/go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,4 @@ require (
github.com/offchainlabs/arbitrum/packages/arb-validator v0.2.0
)


replace github.com/offchainlabs/arbitrum/packages/arb-avm-cpp => ../arb-avm-cpp

0 comments on commit ff6db68

Please sign in to comment.