Updated README
parent
378de24dd1
commit
dcc793c58b
22
README.md
22
README.md
|
|
@ -8,7 +8,7 @@ Such as:
|
|||
- enemy drops and location
|
||||
- command melding for Birth By Sleep
|
||||
- spirit boards for Dream Drop Distance
|
||||
- food simulator for Kingdom Hearts 3
|
||||
- food and pro codes simulators for Kingdom Hearts 3
|
||||
|
||||
## Usage
|
||||
|
||||
|
|
@ -22,21 +22,15 @@ Such as:
|
|||
- git
|
||||
- [Rust 1.85](https://www.rust-lang.org/tools/install)
|
||||
- [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
|
||||
|
||||
1. Clone the repo locally using git
|
||||
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)
|
||||
|
||||
Example of a local Caddyfile:
|
||||
|
||||
```Caddyfile
|
||||
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`
|
||||
3. Configure the web server so it serves files
|
||||
- Caddy: [`file_server`](https://caddyserver.com/docs/caddyfile/directives/file_server)
|
||||
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
|
||||
- Make sure the path served is the same as the `BASE_URL` env var (ex: `site/khguide` corresponds to `BASE_URL="/khguide"`)
|
||||
6. Access the app at `localhost`
|
||||
|
|
|
|||
Loading…
Reference in New Issue