Skip to content

Commit

Permalink
🪄 docs on codespaces
Browse files Browse the repository at this point in the history
  • Loading branch information
kalaspuff authored Jan 5, 2023
1 parent 9fa10a9 commit e57260b
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

<a href="https://github.com/codespaces/new?hide_repo_select=true&ref=master&repo=581580533"><img width="1589" alt="codespace-vscode-screenshot" src="https://user-images.githubusercontent.com/89139/210704071-3c1c5136-9d60-4beb-9f3d-a0409b57475d.png"></a>

### 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

Expand Down Expand Up @@ -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
Expand Down

0 comments on commit e57260b

Please sign in to comment.