From 846b5df2d4c425ee7ce8bd689b9403ddeb665dd5 Mon Sep 17 00:00:00 2001 From: "Dominykas M." <26067386+Tasty-Kiwi@users.noreply.github.com> Date: Wed, 20 Mar 2024 18:14:35 +0200 Subject: [PATCH] fix broken links in intro and update readme --- README.md | 26 +++----------------------- docs/intro.md | 8 ++++---- 2 files changed, 7 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index ba06aa8..e111d18 100644 --- a/README.md +++ b/README.md @@ -7,37 +7,17 @@ This website is built using [Docusaurus](https://docusaurus.io/), a modern stati ### Installation ``` -$ yarn +$ npm install ``` ### Local Development ``` -$ yarn start +$ npm start ``` This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. -### Build - -``` -$ yarn build -``` - -This command generates static content into the `build` directory and can be served using any static contents hosting service. - ### Deployment -Using SSH: - -``` -$ USE_SSH=true yarn deploy -``` - -Not using SSH: - -``` -$ GIT_USER= yarn deploy -``` - -If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch. +The page is deployed automatically via GitHub Actions. diff --git a/docs/intro.md b/docs/intro.md index 2a1e4b8..a8ebf60 100644 --- a/docs/intro.md +++ b/docs/intro.md @@ -14,11 +14,11 @@ If you have questions, the game's creator and many level creators are available # Level structure -A level is a directory that contains a [manifest](API_manifest) and Lua files. The Lua files fall in three categories: +A level is a directory that contains a [manifest](file-information/manifest-files) and Lua files. The Lua files fall in three categories: -- Files that describe [graphics](API_meshes). -- Files that describe [sounds](API_sounds). -- Files that describe the behavior of the level. They make use of the [pewpew](API_pewpew_lib) and [fmath](API_fmath_lib) libraries, which require an understanding of the [types](API_types) used. +- Files that describe [graphics](file-information/mesh-files). +- Files that describe [sounds](file-information/sound-files). +- Files that describe the behavior of the level. They make use of the [pewpew](api/pewpew-library) and [fmath](api/fmath-library) libraries, which require an understanding of the [types](api/types) used. # Uploading your level