Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
512184d
commit 2046153
Showing
1 changed file
with
14 additions
and
18 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,29 +1,25 @@ | ||
## The contents of this GitHub repo are confidential until this disclaimer is removed and the repo is made public | ||
|
||
# UniswapV2 | ||
# Uniswap V2 | ||
|
||
[![Actions Status](https://github.com/Uniswap/uniswap-v2-periphery/workflows/CI/badge.svg)](https://github.com/Uniswap/uniswap-v2-periphery/actions) | ||
|
||
## Local Development | ||
In-depth documentation on Uniswap V2 is available at [uniswap.org](https://uniswap.org/docs). | ||
|
||
# Local Development | ||
|
||
The following assumes the use of `node@>=10`. | ||
|
||
### Clone Repository | ||
## Clone Repository | ||
|
||
`git clone https://github.com/Uniswap/uniswap-v2-periphery.git` | ||
|
||
## Install Dependencies | ||
|
||
``` | ||
git clone https://github.com/Uniswap/uniswap-v2-periphery.git | ||
cd uniswap-v2-periphery | ||
``` | ||
`yarn` | ||
|
||
### Install Dependencies | ||
## Compile Contracts | ||
|
||
``` | ||
yarn | ||
``` | ||
`yarn compile` | ||
|
||
### Compile Contracts and Run Tests | ||
## Run Tests | ||
|
||
``` | ||
yarn compile | ||
yarn test | ||
``` | ||
`yarn test` |