Skip to content

Commit

Permalink
Scaffolding and additions on home
Browse files Browse the repository at this point in the history
  • Loading branch information
katharine-murphy committed Sep 26, 2019
1 parent 361491e commit 97e874f
Show file tree
Hide file tree
Showing 4 changed files with 46 additions and 6 deletions.
Binary file added docs/assets/full-scaffold.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
12 changes: 8 additions & 4 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,18 @@ The AEA is a framework for autonomous economic agent (AEA) development. It gives
The framework is super modular, easily extensible, and highly composable. It is ideal for Reinforcement Learning scenarios.


## Open source platform
## Our vision

!!! Todo
Fetch.AI intends the AEA framework to have two focused commercial roles.

### Open source company

## Platform for start ups
We want to build infrastructure with which external parties build their own solutions.

### Platform for start ups

By operating as a platform for start ups, we hope to solve the chicken-or-egg problem through incentive schemes.

!!! Todo


## Agents
Expand Down
2 changes: 1 addition & 1 deletion docs/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ aea run

You will see the echo task running in the terminal window.

<center>![AEA Visdom UI](assets/echo.png)</center>
<center>![The echo call and response log](assets/echo.png)</center>


### Delete the agent
Expand Down
38 changes: 37 additions & 1 deletion docs/scaffolding.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,39 @@
## Scaffold generator

!!! Todo
The scaffold generator builds out the entire directory structure required for creating a particular skill.

For example, create a new AEA project.

``` bash
aea create new_project
cd new_project
```

Then, cd into your project directory and scaffold your project skill, protocol, or connection.

You will see the directories filled out with the files required and the skill, protocol, or connection registered in the top level `aea-config.yaml`.


### Scaffold a skill

``` bash
aea scaffold skill new_skill
```


### Scaffold a protocol

``` bash
aea scaffold protocol new_protocol
```


### Scaffold a connection

``` bash
aea scaffold connection new_connection
```

After running the above commands, you will have the fully constructured file system required by the AEA.

<center>![The echo call and response log](assets/full-scaffold.png)</center>

0 comments on commit 97e874f

Please sign in to comment.