Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Link to the auction example and remove the quickstart guide #28

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 13 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@ A template repository for your `plutus-tx` smart contract project.

### 1. Create the repository

- From the command line:
- From the command line:

```
gh repo create my-project --private --template IntersectMBO/plutus-tx-template
```

- Or from the [GitHub web page](https://github.com/IntersectMBO/plutus-tx-template), click the top-right green button:
- Or from the [GitHub web page](https://github.com/IntersectMBO/plutus-tx-template), click the top-right green button:

`Use this template -> Create new repository`

- Or just fork/clone `plutus-tx-template` (but note that this is a template repository)
Expand All @@ -23,28 +23,28 @@ A template repository for your `plutus-tx` smart contract project.
### 2. Setup your development environment

- With Nix (**recommended**)

Follow [these instructions](https://github.com/input-output-hk/cardano-node-wiki/blob/main/docs/getting-started/install.md) to install and configure nix, even if you already have it installed.

Then enter the shell using `nix develop`.
Then enter the shell using `nix develop`.

The nix files inside this template follow the [`iogx` flake](https://github.com/input-output-hk/iogx), but you can delete and replace them with your own. In that case, you might want to include the [`devx` flake](https://github.com/input-output-hk/devx/issues) in your flake inputs as a starting point to supply all the necessary dependencies, making sure to use one of the `-iog` flavours.

- With Docker / Devcontainers / Codespaces
From the [GitHub web page](https://github.com/IntersectMBO/plutus-tx-template), click the top-right green button:

From the [GitHub web page](https://github.com/IntersectMBO/plutus-tx-template), click the top-right green button:

`Use this template -> Open in a codespace`

Or let VSCode create a local codespace for you when you open this project.

You can modify your [`devcontainer.json`](./.devcontainer/devcontainer.json) file to customize the container (more info [here](https://github.com/input-output-hk/devx?tab=readme-ov-file#vscode-devcontainer--github-codespace-support)).

Or using your local docker installation (change the `/path/to/my-project` accordingly):
```
docker run \
-v /path/to/my-project:/workspaces/my-project \
-it ghcr.io/input-output-hk/devx-devcontainer:x86_64-linux.ghc96-iog
-it ghcr.io/input-output-hk/devx-devcontainer:x86_64-linux.ghc96-iog
```

When using this approach, you can ignore/delete/replace the nix files entirely.
Expand All @@ -57,4 +57,4 @@ A template repository for your `plutus-tx` smart contract project.

### 3. Run the example application

Run `cabal update` first, then read [app/QUICKSTART.md](./app/QUICKSTART.md) to get started.
Run `cabal update` first, then read [Example: An Auction Smart Contract](https://plutus.cardano.intersectmbo.org/docs/category/example-an-auction-smart-contract) to get started.
60 changes: 0 additions & 60 deletions app/QUICKSTART.md

This file was deleted.