diff --git a/README.md b/README.md index d62424f..2bab7bb 100644 --- a/README.md +++ b/README.md @@ -1,57 +1,32 @@ -# StorytellerBevy +# Storyteller Studio - +## Installing dependencies +* [Install Rust](https://www.rust-lang.org/tools/install) +* [Install Node.js LTS](https://nodejs.org/en) +* Run `npm ci` -✨ **This workspace has been generated by [Nx, a Smart, fast and extensible build system.](https://nx.dev)** ✨ - -## Generate code - -If you happen to use Nx plugins, you can leverage code generators that might come with it. - -Run `nx list` to get a list of available plugins and whether they have generators. Then run `nx list ` to see what generators are available. - -Learn more about [Nx generators on the docs](https://nx.dev/plugin-features/use-code-generators). - -## Running tasks - -To execute tasks with Nx use the following syntax: - -``` -nx <...options> +## Building / Running / Testing stuff +This repo is managed by [Nx](https://nx.dev), a polyglot build system and +monorepo framework written in TypeScript. After installing dependencies, dev +tasks can be run through the Nx CLI: +```sh +npx nx [options] +# OR +npx nx run : [options] ``` -You can also run multiple targets: - +For example, to compile the Bevy app to WebAssembly and serve it via the web +frontend project, run: ``` -nx run-many -t +npx nx serve studio-frontend ``` -..or add `-p` to filter specific projects +Projects are located in directories at the workspace root. The list of commands +supported by a given project can be found under the `target` property of its +`project.json` file, which defines the Nx configuration for that project. +The full list of options for a given command can be discovered by passing the +`--help` flag: ``` -nx run-many -t -p +npx nx --help ``` - -Targets can be defined in the `package.json` or `projects.json`. Learn more [in the docs](https://nx.dev/core-features/run-tasks). - -## Want better Editor Integration? - -Have a look at the [Nx Console extensions](https://nx.dev/nx-console). It provides autocomplete support, a UI for exploring and running tasks & generators, and more! Available for VSCode, IntelliJ and comes with a LSP for Vim users. - -## Ready to deploy? - -Just run `nx build demoapp` to build the application. The build artifacts will be stored in the `dist/` directory, ready to be deployed. - -## Set up CI! - -Nx comes with local caching already built-in (check your `nx.json`). On CI you might want to go a step further. - -- [Set up remote caching](https://nx.dev/core-features/share-your-cache) -- [Set up task distribution across multiple machines](https://nx.dev/core-features/distribute-task-execution) -- [Learn more how to setup CI](https://nx.dev/recipes/ci) - -## Connect with us! - -- [Join the community](https://nx.dev/community) -- [Subscribe to the Nx Youtube Channel](https://www.youtube.com/@nxdevtools) -- [Follow us on Twitter](https://twitter.com/nxdevtools)