From e57260b4d9ea031f1dfc9834b7785dd59d661ce0 Mon Sep 17 00:00:00 2001 From: Carl Oscar Aaro Date: Thu, 5 Jan 2023 05:58:26 +0100 Subject: [PATCH] =?UTF-8?q?=F0=9F=AA=84=20docs=20on=20codespaces?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 10e604d..9d38e5e 100644 --- a/README.md +++ b/README.md @@ -10,21 +10,24 @@ * 🪄 Sensible setup for linting, code formatting — includes VSCode settings for auto code style, etc. * 📚 Includes some common libraries (such as OpenZeppelin, solmate and contracts from Safe). * 🎉 Aims to make it easy for devs to prototype and code contracts without the effort of the initial chores. -* 💫 There's also a dev container setup included with the repo to make it work with codespaces, etc. ### GitHub Codespaces -It takes ~ 90 seconds for the [codespace](https://github.com/features/codespaces) to install and spin up. It provides a complete dev setup with all the dependencies and VSCode extensions installed. Everything needed to develop, build and deploy contracts. ✌️ +There's also a dev container setup included in this repo to make it super easy to set up with codespaces. + +It takes ~ 90 seconds for the [codespace](https://github.com/features/codespaces) to install and spin up. It provides a complete dev setup with all the dependencies and VSCode extensions installed. Everything needed to develop, build and deploy contracts. 💫 [![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://github.com/codespaces/new?hide_repo_select=true&ref=master&repo=581580533) +codespace-vscode-screenshot + ### Contributions If you find any bugs 🐛 in the contracts, in this documentation or if you have ideas 💡 of ways to make this more useful and dev friendly – please open an issue or PR on GitHub [`➔ kalaspuff/solidity-template`](https://github.com/kalaspuff/solidity-template). 🙏 ## Get started -These instructions expect you to be running a Linux or macOS system with Foundry and build essentials already installed. This *might* also work on another setup (such as WSL or other shells) where you can use environment values + use the Foundry CLI (eventually USB permissions also required in case you need to access a USB connected cold wallet). +These section is for setting up the environment without the use of GitHub Codespaces. The instructions expect you to be running a Linux or macOS system with Foundry and build essentials already installed. ### 🏃 ⌁ Initialize and install dependencies @@ -70,7 +73,7 @@ origin https://github.com/coder/my-contract (push) ## Development -A couple of `make` commands are available for convenience and quality of life. +A couple of `make` commands are available for convenience and general quality of life. ```console user@cpu:~/code/my-contract $ make