From 375fb27dff35b9c6eb64ab255169cc6e64d58063 Mon Sep 17 00:00:00 2001 From: joao Date: Wed, 10 Jul 2024 22:09:14 +0100 Subject: [PATCH] WIP --- README.md | 23 ++++++++++++++++++----- 1 file changed, 18 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index e557fd65..0a7b52f9 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,14 @@ # ts-topology The official TypeScript implementation of Topology Protocol -### Development +## Introducion + +## Development To build and run this project you'll need to have [yarn](https://classic.yarnpkg.com/lang/en/docs/install/#debian-stable) installed. If you don't have yarn installed, go ahead and install the latest version. -#### Build Project +### Build Project Install the dependecies of every package of the project. ```sh @@ -38,14 +40,25 @@ Install the dependecies of every package of the project. ``` -#### Run Project -To run the exemple-canvas run: +### Run Project +To run the exemple-canvas execute: ```sh + >cd examples/canvas # this will execute "webpack serve" > yarn dev + ``` -This command will ... TODO +This command will create a development server for the project at http://localhost:3000/. + + + +## Example +For a better undestandability of this project we explain using an example. + + + +