Skip to content

Commit

Permalink
sunset femplate (#1042)
Browse files Browse the repository at this point in the history
  • Loading branch information
refcell authored Nov 17, 2023
1 parent 6737319 commit 2b4f80d
Show file tree
Hide file tree
Showing 5 changed files with 24 additions and 14 deletions.
12 changes: 6 additions & 6 deletions scripts/generate-output-forge
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,12 @@ echo "Generating output (forge)..."
(run_command forge test) > $OUTPUT_DIR/hello_foundry/forge-test
)
(
in_temp femplate
git clone https://github.com/abigger87/femplate
cd femplate
(run_command forge install) > $OUTPUT_DIR/femplate/forge-install
(run_command forge build) > $OUTPUT_DIR/femplate/forge-build
(run_command forge test) > $OUTPUT_DIR/femplate/forge-test
in_temp foundry-template
git clone https://github.com/PaulRBerg/foundry-template
cd foundry-template
(run_command forge install) > $OUTPUT_DIR/foundry-template/forge-install
(run_command forge build) > $OUTPUT_DIR/foundry-template/forge-build
(run_command forge test) > $OUTPUT_DIR/foundry-template/forge-test
)
(
in_temp deps
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
26 changes: 18 additions & 8 deletions src/projects/working-on-an-existing-project.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,35 @@
## Working on an Existing Project

Foundry makes developing with existing projects have no overhead.

For this example, we will use [PaulRBerg][paul]'s [`foundry-template`][template].

If you download an existing project that uses Foundry, it is really easy to get going.

First, get the project from somewhere. In this example, we will clone the `femplate` repository from GitHub:
First, clone the project and run [`forge install`][install] inside the project directory.

```sh
$ git clone https://github.com/abigger87/femplate
$ cd femplate
$ git clone https://github.com/PaulRBerg/foundry-template
$ cd foundry-template
$ forge install
```

We run [`forge install`](../reference/forge/forge-install.md) to install the submodule dependencies that are in the project.
We run [`forge install`][install] to install the submodule dependencies that are in the project.

To build, use [`forge build`](../reference/forge/forge-build.md):
To build, use [`forge build`][build]:

```sh
{{#include ../output/femplate/forge-build:all}}
{{#include ../output/foundry-template/forge-build:all}}
```

And to test, use [`forge test`](../reference/forge/forge-test.md):
And to test, use [`forge test`][test]:

```sh
{{#include ../output/femplate/forge-test:all}}
{{#include ../output/foundry-template/forge-test:all}}
```

[paul]: https://github.com/PaulRBerg
[template]: https://github.com/PaulRBerg/foundry-template
[install]: ../reference/forge/forge-install.md
[build]: ../reference/forge/forge-build.md
[test]: ../reference/forge/forge-test.md

0 comments on commit 2b4f80d

Please sign in to comment.