From c0dc1a3843a5b5244c387f996f3259cacfc5f405 Mon Sep 17 00:00:00 2001 From: Kevin Weaver Date: Fri, 17 Dec 2021 15:56:57 -0500 Subject: [PATCH 1/3] Replace README with deprecation warning an a similar tutorial link. --- README.md | 38 ++------------------------------------ 1 file changed, 2 insertions(+), 36 deletions(-) diff --git a/README.md b/README.md index 7fd1473..1090c05 100644 --- a/README.md +++ b/README.md @@ -1,40 +1,6 @@ # TutorialToken Truffle Box -This box has all you need to get started with our [Open Zeppelin (TutorialToken) tutorial](http://truffleframework.com/tutorials/robust-smart-contracts-with-openzeppelin). +## This box is deprecated. It is likely some features in this box will not work as expected. -## Installation +Consider following [this tutorial](https://forum.openzeppelin.com/t/create-an-erc20-using-truffle-without-writing-solidity/2713) to create an ERC20 with truffle. -1. Install Truffle globally. - ```javascript - npm install -g truffle - ``` - -2. Download the box. This also takes care of installing the necessary dependencies. - ```javascript - truffle unbox tutorialtoken - ``` - -3. Run the development console. - ```javascript - truffle develop - ``` - -4. Compile and migrate the smart contracts. Note inside the development console we don't preface commands with `truffle`. - ```javascript - compile - migrate - ``` - -5. Run the `liteserver` development server (outside the development console) for front-end hot reloading. Smart contract changes must be manually recompiled and migrated. - ```javascript - // Serves the front-end on http://localhost:3000 - npm run dev - ``` - -**NOTE**: This box is not a complete dapp, but the starting point for the [Open Zeppelin (TutorialToken) tutorial](http://truffleframework.com/tutorials/robust-smart-contracts-with-openzeppelin). You'll need to complete that for this to function. - -## FAQ - -* __How do I use this with the EthereumJS TestRPC?__ - - It's as easy as modifying the config file! [Check out our documentation on adding network configurations](http://truffleframework.com/docs/advanced/configuration#networks). Depending on the port you're using, you'll also need to update line 16 of `src/js/app.js`. From 2691ac7a62288f30ed80778f800ae54d6947198d Mon Sep 17 00:00:00 2001 From: Kevin Weaver Date: Mon, 3 Jan 2022 13:27:39 -0500 Subject: [PATCH 2/3] Return original README --- README.md | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) diff --git a/README.md b/README.md index 1090c05..a42b3cb 100644 --- a/README.md +++ b/README.md @@ -4,3 +4,39 @@ Consider following [this tutorial](https://forum.openzeppelin.com/t/create-an-erc20-using-truffle-without-writing-solidity/2713) to create an ERC20 with truffle. +## Installation + +1. Install Truffle globally. + ```javascript + npm install -g truffle + ``` + +2. Download the box. This also takes care of installing the necessary dependencies. + ```javascript + truffle unbox tutorialtoken + ``` + +3. Run the development console. + ```javascript + truffle develop + ``` + +4. Compile and migrate the smart contracts. Note inside the development console we don't preface commands with `truffle`. + ```javascript + compile + migrate + ``` + +5. Run the `liteserver` development server (outside the development console) for front-end hot reloading. Smart contract changes must be manually recompiled and migrated. + ```javascript + // Serves the front-end on http://localhost:3000 + npm run dev + ``` + +**NOTE**: This box is not a complete dapp, but the starting point for the [Open Zeppelin (TutorialToken) tutorial](http://truffleframework.com/tutorials/robust-smart-contracts-with-openzeppelin). You'll need to complete that for this to function. + +## FAQ + +* __How do I use this with the EthereumJS TestRPC?__ + + It's as easy as modifying the config file! [Check out our documentation on adding network configurations](http://truffleframework.com/docs/advanced/configuration#networks). Depending on the port you're using, you'll also need to update line 16 of `src/js/app.js`. From 68bdaaa2112dd812847cdd3af41375d949dead79 Mon Sep 17 00:00:00 2001 From: Kevin Weaver Date: Tue, 18 Jan 2022 12:37:25 -0500 Subject: [PATCH 3/3] Return fixed openzeppelin deprecated guide url --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index a42b3cb..55532a8 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,10 @@ -# TutorialToken Truffle Box - ## This box is deprecated. It is likely some features in this box will not work as expected. -Consider following [this tutorial](https://forum.openzeppelin.com/t/create-an-erc20-using-truffle-without-writing-solidity/2713) to create an ERC20 with truffle. +Consider following [this tutorial](https://forum.openzeppelin.com/t/create-an-erc20-using-truffle-without-writing-solidity/2713) to create an ERC20 with truffle instead. + +# TutorialToken Truffle Box + +This box has all you need to get started with our [Open Zeppelin (TutorialToken) tutorial](https://trufflesuite.com/guides/robust-smart-contracts-with-openzeppelin/). ## Installation