Skip to content

Commit

Permalink
Add more to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
chasefleming committed Nov 5, 2024
1 parent be99042 commit c6a2839
Show file tree
Hide file tree
Showing 4 changed files with 80 additions and 0 deletions.
20 changes: 20 additions & 0 deletions internal/super/generator/fixtures/README_no_deps.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,26 @@ Inside the `cadence` folder you will find:
- `/tests` - This folder contains your Cadence tests (integration tests for your contracts, scripts, and transactions to verify they behave as expected)
- `ExampleTest.cdc`

## Running the Existing Project

### Executing the `GetCounter` Script

To run the `GetCounter` script, use the following command:

```shell
flow scripts execute cadence/scripts/GetCounter.cdc
```

### Sending the `IncrementCounter` Transaction

To run the `IncrementCounter` transaction, use the following command:

```shell
flow transactions send cadence/transactions/IncrementCounter.cdc
```

To learn more about using the CLI, check out the [Flow CLI Documentation](https://developers.flow.com/tools/flow-cli).

## 👨‍💻 Start Developing

### Creating a New Contract
Expand Down
20 changes: 20 additions & 0 deletions internal/super/generator/fixtures/README_with_deps.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,26 @@ Inside the `cadence` folder you will find:
- `/tests` - This folder contains your Cadence tests (integration tests for your contracts, scripts, and transactions to verify they behave as expected)
- `ExampleTest.cdc`

## Running the Existing Project

### Executing the `GetCounter` Script

To run the `GetCounter` script, use the following command:

```shell
flow scripts execute cadence/scripts/GetCounter.cdc
```

### Sending the `IncrementCounter` Transaction

To run the `IncrementCounter` transaction, use the following command:

```shell
flow transactions send cadence/transactions/IncrementCounter.cdc
```

To learn more about using the CLI, check out the [Flow CLI Documentation](https://developers.flow.com/tools/flow-cli).

## 👨‍💻 Start Developing

### Creating a New Contract
Expand Down
20 changes: 20 additions & 0 deletions internal/super/generator/templates/README.md.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,26 @@ Inside the `cadence` folder you will find:
- `/tests` - This folder contains your Cadence tests (integration tests for your contracts, scripts, and transactions to verify they behave as expected){{ range .Tests }}
- `{{ .Name }}.cdc`{{ end }}

## Running the Existing Project

### Executing the `GetCounter` Script

To run the `GetCounter` script, use the following command:

```shell
flow scripts execute cadence/scripts/GetCounter.cdc
```

### Sending the `IncrementCounter` Transaction

To run the `IncrementCounter` transaction, use the following command:

```shell
flow transactions send cadence/transactions/IncrementCounter.cdc
```

To learn more about using the CLI, check out the [Flow CLI Documentation](https://developers.flow.com/tools/flow-cli).

## 👨‍💻 Start Developing

### Creating a New Contract
Expand Down
20 changes: 20 additions & 0 deletions testing/better/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,26 @@ Inside `cadence` folder you will find:
- `/tests` - This folder contains your Cadence tests (integration tests for your contracts, scripts, and transactions to verify they behave as expected)
- `Counter_test.cdc`

## Running the Existing Project

### Executing the `GetCounter` Script

To run the `GetCounter` script, use the following command:

```shell
flow scripts execute cadence/scripts/GetCounter.cdc
```

### Sending the `IncrementCounter` Transaction

To run the `IncrementCounter` transaction, use the following command:

```shell
flow transactions send cadence/transactions/IncrementCounter.cdc
```

To learn more about using the CLI, check out the [Flow CLI Documentation](https://developers.flow.com/tools/flow-cli).

## 👨‍💻 Start Developing

### Creating a New Contract
Expand Down

0 comments on commit c6a2839

Please sign in to comment.