Skip to content

Commit

Permalink
fix broken links in intro and update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Tasty-Kiwi committed Mar 20, 2024
1 parent 7ed45d3 commit 846b5df
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 27 deletions.
26 changes: 3 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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=<Your GitHub username> 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.
8 changes: 4 additions & 4 deletions docs/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit 846b5df

Please sign in to comment.