From b6cdd497e1fc2e353ffb37be94f043ec8087bf5a Mon Sep 17 00:00:00 2001 From: Kevin Ho Date: Tue, 11 Feb 2020 19:22:09 -0500 Subject: [PATCH 1/3] Update README --- README.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 24eea06ff08ad..eeca24047d662 100644 --- a/README.md +++ b/README.md @@ -4,24 +4,24 @@ [Optimism](hhttps://optimism.io/) is a Public Benefit Corporation dedicated to scaling Ethereum in a way that enshrines fair access to public goods. Optimism is focused on implementing a production-level Optimistic Rollup implementation that integrates with the Optimistic Virtual Machine (OVM) to scale arbitrary Solidity smart contracts. -`@optipus` is the Optimism monorepo. -All of the core Optimism projects are hosted inside of the [packages](https://github.com/ethereum-optimism/optipus/tree/master/packages) folder of this repository. +`@optimism-monorepo` is the Optimism monorepo. +All of the core Optimism projects are hosted inside of the [packages](https://github.com/ethereum-optimism/optimism-monorepo/tree/master/packages) folder of this repository. ## Packages | Package | Version | Description | | ------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------| -| [`@optipus/ovm`](/packages/ovm) | [![npm](https://img.shields.io/npm/v/@optipus/ovm.svg)](https://www.npmjs.com/package/@optipus/ovm) | Optimistic Virtual Machine | -| [`@optipus/rollup-full-node`](/packages/rollup-full-node) | [![npm](https://img.shields.io/npm/v/@optipus/rollup-full-node.svg)](https://www.npmjs.com/package/@optipus/rollup-full-node) | Fullnode RPC server for the OVM | -| [`@optipus/rollup-dev-tools`](/packages/rollup-dev-tools) | [![npm](https://img.shields.io/npm/v/@optipus/rollup-dev-tools.svg)](https://www.npmjs.com/package/@optipus/rollup-dev-tools) | Optimistic Rollup development tooling (includes Transpiler) | +| [`@eth-optimism/ovm`](/packages/ovm) | [![npm](https://img.shields.io/npm/v/@eth-optimism/ovm.svg)](https://www.npmjs.com/package/@eth-optimism/ovm) | Optimistic Virtual Machine | +| [`@eth-optimism/rollup-full-node`](/packages/rollup-full-node) | [![npm](https://img.shields.io/npm/v/@eth-optimism/rollup-full-node.svg)](https://www.npmjs.com/package/@eth-optimism/rollup-full-node) | Fullnode RPC server for the OVM | +| [`@eth-optimism/rollup-dev-tools`](/packages/rollup-dev-tools) | [![npm](https://img.shields.io/npm/v/@eth-optimism/rollup-dev-tools.svg)](https://www.npmjs.com/package/@eth-optimism/rollup-dev-tools) | Optimistic Rollup development tooling (includes Transpiler) | ## Repo Status -![CI - Build, Test, Lint](https://github.com/ethereum-optimism/optipus/workflows/CI%20-%20Build,%20Test,%20Lint/badge.svg?branch=master) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/05852734abaf4567a864cdd19169d70b)](https://www.codacy.com/gh/ethereum-optimism/optipus?utm_source=github.com&utm_medium=referral&utm_content=ethereum-optimism/optipus&utm_campaign=Badge_Grade) +![CI - Build, Test, Lint](https://github.com/ethereum-optimism/optimism-monorepo/workflows/CI%20-%20Build,%20Test,%20Lint/badge.svg?branch=master) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/05852734abaf4567a864cdd19169d70b)](https://www.codacy.com/gh/ethereum-optimism/optimism-monorepo?utm_source=github.com&utm_medium=referral&utm_content=ethereum-optimism/optimism-monorepo&utm_campaign=Badge_Grade) ## Contributing Welcome! If you're looking to contribute to the future of Ethereum, you're in the right place. ### Contributing Guide and Code of Conduct -Optimism follows a [Contributing Guide and Code of Conduct](https://github.com/ethereum-optimism/optipus/blob/master/.github/CONTRIBUTING.md) adapted slightly from the [Contributor Covenant](https://www.contributor-covenant.org/version/1/4/code-of-conduct.html). +Optimism follows a [Contributing Guide and Code of Conduct](https://github.com/ethereum-optimism/optimism-monorepo/blob/master/.github/CONTRIBUTING.md) adapted slightly from the [Contributor Covenant](https://www.contributor-covenant.org/version/1/4/code-of-conduct.html). All contributors **must** read through this guide before contributing. We're here to cultivate a welcoming and inclusive contributing environment, and every new contributor needs to do their part to uphold our community standards. @@ -30,17 +30,17 @@ We're here to cultivate a welcoming and inclusive contributing environment, and Before you start working on an Optimism project, you'll need to clone our GitHub repository: ```sh -git clone git@github.com:ethereum-optimism/optipus.git +git clone git@github.com:ethereum-optimism/optimism-monorepo.git ``` Now, enter the repository. ```sh -cd optipus +cd optimism-monorepo ``` #### Node.js -Most of the projects in `@optipus` are [`Node.js`](https://nodejs.org/en/) projects. +Most of the projects in `optimism-monorepo` are [`Node.js`](https://nodejs.org/en/) projects. You'll need to install `Node.js` for your system before continuing. All code is only confirmed to work on `Node.js v11.6`, and there are known issues on more recent versions. Please [set your Node.js version to 11.6](https://stackoverflow.com/a/23569481). @@ -49,7 +49,7 @@ We're using a package manager called [Yarn](https://yarnpkg.com/en/). You'll need to [install Yarn](https://yarnpkg.com/en/docs/install) before continuing. #### Installing Dependencies -`@optipus` projects make use of several external packages. +`optimism-monorepo` projects make use of several external packages. Install all required packages with: @@ -58,7 +58,7 @@ yarn install ``` ### Building -`@optipus` provides convenient tooling for building a package or set of packages. +`optimism-monorepo` provides convenient tooling for building a package or set of packages. Build all packages: @@ -104,7 +104,7 @@ PKGS=your,packages,here yarn run fix ``` ### Running Tests -`@optipus` projects usually makes use of a combination of [`Mocha`](https://mochajs.org/) (a testing framework) and [`Chai`](https://www.chaijs.com/) (an assertion library) for testing. +`optimism-monorepo` projects usually makes use of a combination of [`Mocha`](https://mochajs.org/) (a testing framework) and [`Chai`](https://www.chaijs.com/) (an assertion library) for testing. Run all tests: From f83cbe37d3ab6bb79c37229b8c36ce31ba5e166c Mon Sep 17 00:00:00 2001 From: Kevin Ho Date: Tue, 11 Feb 2020 19:24:32 -0500 Subject: [PATCH 2/3] minor fixes --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index eeca24047d662..3f803d4059c26 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,10 @@ --- -[Optimism](hhttps://optimism.io/) is a Public Benefit Corporation dedicated to scaling Ethereum in a way that enshrines fair access to public goods. Optimism is focused on implementing a production-level Optimistic Rollup implementation that integrates with the Optimistic Virtual Machine (OVM) to scale arbitrary Solidity smart contracts. +[Optimism](https://optimism.io/) is a Public Benefit Corporation dedicated to scaling Ethereum in a way that enshrines fair access to public goods. Optimism is focused on implementing a production-level Optimistic Rollup implementation that integrates with the Optimistic Virtual Machine (OVM) to scale arbitrary Solidity smart contracts. + +To get involved, follow us on [Twitter](https://twitter.com/optimismPBC), join our [Discord](https://discordapp.com/invite/jrnFEvq), and try out our [OVM tutorial](https://github.com/ethereum-optimism/ERC20-Example)! + `@optimism-monorepo` is the Optimism monorepo. All of the core Optimism projects are hosted inside of the [packages](https://github.com/ethereum-optimism/optimism-monorepo/tree/master/packages) folder of this repository. From 3a45b4e6d4d383c889d1757aad2bfc4c9715121d Mon Sep 17 00:00:00 2001 From: Kevin Ho Date: Tue, 11 Feb 2020 19:38:32 -0500 Subject: [PATCH 3/3] fix table formatting --- README.md | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 3f803d4059c26..feb4d193ef899 100644 --- a/README.md +++ b/README.md @@ -6,17 +6,16 @@ To get involved, follow us on [Twitter](https://twitter.com/optimismPBC), join our [Discord](https://discordapp.com/invite/jrnFEvq), and try out our [OVM tutorial](https://github.com/ethereum-optimism/ERC20-Example)! - `@optimism-monorepo` is the Optimism monorepo. All of the core Optimism projects are hosted inside of the [packages](https://github.com/ethereum-optimism/optimism-monorepo/tree/master/packages) folder of this repository. ## Packages -| Package | Version | Description | -| ------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------| -| [`@eth-optimism/ovm`](/packages/ovm) | [![npm](https://img.shields.io/npm/v/@eth-optimism/ovm.svg)](https://www.npmjs.com/package/@eth-optimism/ovm) | Optimistic Virtual Machine | -| [`@eth-optimism/rollup-full-node`](/packages/rollup-full-node) | [![npm](https://img.shields.io/npm/v/@eth-optimism/rollup-full-node.svg)](https://www.npmjs.com/package/@eth-optimism/rollup-full-node) | Fullnode RPC server for the OVM | -| [`@eth-optimism/rollup-dev-tools`](/packages/rollup-dev-tools) | [![npm](https://img.shields.io/npm/v/@eth-optimism/rollup-dev-tools.svg)](https://www.npmjs.com/package/@eth-optimism/rollup-dev-tools) | Optimistic Rollup development tooling (includes Transpiler) | +| Package | Version | Description | +|----------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------| +| [`@eth-optimism/ovm`](/packages/ovm) | [![npm](https://img.shields.io/npm/v/@eth-optimism/ovm.svg)](https://www.npmjs.com/package/@eth-optimism/ovm) | Optimistic Virtual Machine | +| [`@eth-optimism/rollup-full-node`](/packages/rollup-full-node) | [![npm](https://img.shields.io/npm/v/@eth-optimism/rollup-full-node.svg)](https://www.npmjs.com/package/@eth-optimism/rollup-full-node) | Fullnode RPC server for the OVM | +| [`@eth-optimism/rollup-dev-tools`](/packages/rollup-dev-tools) | [![npm](https://img.shields.io/npm/v/@eth-optimism/rollup-dev-tools.svg)](https://www.npmjs.com/package/@eth-optimism/rollup-dev-tools) | Optimistic Rollup development tooling (includes Transpiler) | | ## Repo Status ![CI - Build, Test, Lint](https://github.com/ethereum-optimism/optimism-monorepo/workflows/CI%20-%20Build,%20Test,%20Lint/badge.svg?branch=master) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/05852734abaf4567a864cdd19169d70b)](https://www.codacy.com/gh/ethereum-optimism/optimism-monorepo?utm_source=github.com&utm_medium=referral&utm_content=ethereum-optimism/optimism-monorepo&utm_campaign=Badge_Grade)