diff --git a/COPYING.md b/COPYING.md new file mode 100644 index 000000000..58de02861 --- /dev/null +++ b/COPYING.md @@ -0,0 +1 @@ +TODO: write licensing info diff --git a/README.md b/README.md index 6d32f9883..5d2379764 100644 --- a/README.md +++ b/README.md @@ -1,76 +1,3 @@ -# Monorepo +# Olympus (Modrinth monorepo) - - -✨ **This workspace has been generated by [Nx, Smart Monorepos · Fast CI.](https://nx.dev)** ✨ - -## Integrate with editors - -Enhance your Nx experience by installing [Nx Console](https://nx.dev/nx-console) for your favorite editor. Nx Console -provides an interactive UI to view your projects, run tasks, generate code, and more! Available for VSCode, IntelliJ and -comes with a LSP for Vim users. - -## Nx plugins and code generators - -Add Nx plugins to leverage their code generators and automated, inferred tasks. - -``` -# Add plugin -npx nx add @nx/react - -# Use code generator -npx nx generate @nx/react:app demo - -# Run development server -npx nx serve demo - -# View project details -npx nx show project demo --web -``` - -Run `npx nx list` to get a list of available plugins and whether they have generators. Then run `npx nx list ` to see what generators are available. - -Learn more about [code generators](https://nx.dev/features/generate-code) and [inferred tasks](https://nx.dev/concepts/inferred-tasks) in the docs. - -## Running tasks - -To execute tasks with Nx use the following syntax: - -``` -npx nx <...options> -``` - -You can also run multiple targets: - -``` -npx nx run-many -t -``` - -..or add `-p` to filter specific projects - -``` -npx nx run-many -t -p -``` - -Targets can be defined in the `package.json` or `projects.json`. Learn more [in the docs](https://nx.dev/features/run-tasks). - -## 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/features/share-your-cache) -- [Set up task distribution across multiple machines](https://nx.dev/nx-cloud/features/distribute-task-execution) -- [Learn more how to setup CI](https://nx.dev/recipes/ci) - -## Explore the project graph - -Run `npx nx graph` to show the graph of the workspace. -It will show tasks that you can run with Nx. - -- [Learn more about Exploring the Project Graph](https://nx.dev/core-features/explore-graph) - -## 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) +TODO: write rest of readme diff --git a/package.json b/package.json index 10b28b188..84ae1c052 100644 --- a/package.json +++ b/package.json @@ -1,5 +1,5 @@ { - "name": "@modrinth/source", + "name": "@modrinth/olympus", "version": "0.0.0", "license": "MIT", "scripts": {},