-
Notifications
You must be signed in to change notification settings - Fork 694
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
5 changed files
with
24 additions
and
14 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |