Updated README
parent
378de24dd1
commit
dcc793c58b
22
README.md
22
README.md
|
|
@ -8,7 +8,7 @@ Such as:
|
||||||
- enemy drops and location
|
- enemy drops and location
|
||||||
- command melding for Birth By Sleep
|
- command melding for Birth By Sleep
|
||||||
- spirit boards for Dream Drop Distance
|
- spirit boards for Dream Drop Distance
|
||||||
- food simulator for Kingdom Hearts 3
|
- food and pro codes simulators for Kingdom Hearts 3
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
|
|
@ -22,21 +22,15 @@ Such as:
|
||||||
- git
|
- git
|
||||||
- [Rust 1.85](https://www.rust-lang.org/tools/install)
|
- [Rust 1.85](https://www.rust-lang.org/tools/install)
|
||||||
- [Just](https://github.com/casey/just?tab=readme-ov-file#installation)
|
- [Just](https://github.com/casey/just?tab=readme-ov-file#installation)
|
||||||
- A locally running web server such as [caddy](https://github.com/caddyserver/caddy)
|
- A locally running web server that can serve files, such as [caddy](https://github.com/caddyserver/caddy)
|
||||||
|
|
||||||
### Setup
|
### Setup
|
||||||
|
|
||||||
1. Clone the repo locally using git
|
1. Clone the repo locally using git
|
||||||
2. Setup your web server and make sure it runs
|
2. Setup your web server and make sure it runs
|
||||||
3. Configure the web server so it serves files via caddy's [`file_server`](https://caddyserver.com/docs/caddyfile/directives/file_server)
|
3. Configure the web server so it serves files
|
||||||
|
- Caddy: [`file_server`](https://caddyserver.com/docs/caddyfile/directives/file_server)
|
||||||
Example of a local Caddyfile:
|
4. Use `just` or `just build` this will generate all the HTML files
|
||||||
|
5. Copy all assets from the newly generated `out` folder inside caddy's `site` folder to be served
|
||||||
```Caddyfile
|
- Make sure the path served is the same as the `BASE_URL` env var (ex: `site/khguide` corresponds to `BASE_URL="/khguide"`)
|
||||||
localhost
|
6. Access the app at `localhost`
|
||||||
|
|
||||||
file_server
|
|
||||||
```
|
|
||||||
|
|
||||||
4. Use `just` or `just build` this will generate all the HTML files and copy all assets into an `out` folder which may copy the contents of inside caddy's `site` folder to be served
|
|
||||||
5. Access the app at `localhost`
|
|
||||||
|
|
|
||||||
5
justfile
5
justfile
|
|
@ -2,11 +2,8 @@ set export
|
||||||
set quiet
|
set quiet
|
||||||
set dotenv-load
|
set dotenv-load
|
||||||
|
|
||||||
build publish="false":
|
build:
|
||||||
#!/usr/bin/env bash
|
#!/usr/bin/env bash
|
||||||
if [ "{{publish}}" = false ]; then
|
|
||||||
export BASE_URL=""
|
|
||||||
fi
|
|
||||||
mkdir -p ./out
|
mkdir -p ./out
|
||||||
rm -rf ./out/*
|
rm -rf ./out/*
|
||||||
cargo run
|
cargo run
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue