diff --git a/README.md b/README.md index 96b6e97c7b..6f577901b2 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,47 @@ # FTL README [![CI](https://github.com/TBD54566975/ftl/actions/workflows/ci.yml/badge.svg)](https://github.com/TBD54566975/ftl/actions/workflows/ci.yml) -## Introduction +## Getting started + +### Install hermit, for example on macos: +```sh +brew install hermit +``` + +### Create a sample project (kotlin) +```sh +mkdir myproject +cd myproject +git init . +hermit init . +. ./bin/activate-hermit +./bin/hermit install ftl +``` + +### Create a kotlin module +```sh +ftl init kotlin . alice +``` + +### Serve FTL in a seperate terminal +`ftl serve` + +### Deploy and test the module +```sh +ftl deploy ftl-module-alice +ftl call alice.echo '{"name": "Mic"}' +``` + + + +### Remember to activate hermit any time you are in the project +```sh +. ./bin/activate-hermit +``` + +![ftl hacking faster than light](https://github.com/TBD54566975/ftl/assets/14976/37b65b44-021b-4da1-abc2-a5dbcc126c47) + + -TBD... ## Project Resources @@ -12,4 +51,4 @@ TBD... | [CODE_OF_CONDUCT.md](./CODE_OF_CONDUCT.md) | Expected behavior for project contributors, promoting a welcoming environment | | [CONTRIBUTING.md](./CONTRIBUTING.md) | Developer guide to build, test, run, access CI, chat, discuss, file issues | | [GOVERNANCE.md](./GOVERNANCE.md) | Project governance | -| [LICENSE](./LICENSE) | Apache License, Version 2.0 | \ No newline at end of file +| [LICENSE](./LICENSE) | Apache License, Version 2.0 |