mascully_website/README.md
Markus Scully bab8fe827a
📝 README.md: Add documentation for SHA256 note, binaryen install, and config section
- Added note about repository using SHA256 object format with Nix compatibility details.
- Added installation step for `binaryen` in non-Nix run instructions.
- Added new "Configuration" section explaining how to modify bind address and port.
2025-07-27 09:19:24 +03:00

46 lines
1.3 KiB
Markdown

# Mascully Website
My personal website. Hosted at [mascully.com](https://mascully.com). The currently hosted version may not always exactly reflect the contents of this repo.
Built using [Leptos](https://leptos.dev/) with [Axum](https://github.com/tokio-rs/axum).
This repo uses the SHA256 object format so it may be incompatible with a lot of tools. See [here](https://github.com/NixOS/nix/issues/11561) for instructions on using this repo with Nix.
## Running
### Nix
Run directly with
```bash
nix develop -c cargo-leptos serve
```
Develop with
```bash
nix develop
cargo-leptos watch
```
I'm still working on getting the flake working, so for now you can't use `nix run`. I also haven't figured out how to bundle it as a standalone binary yet.
### Other systems
- Install Rust nightly.
- Install [Cargo Leptos](https://github.com/leptos-rs/cargo-leptos).
- Install [binaryen](https://github.com/WebAssembly/binaryen).
- `cargo-leptos serve`
## Configuration
The bind address and port can be modifed in the top-level `Cargo.toml` file under `workspace.metadata.leptos`.
## Code structure
- `crates/app`: The actual website.
- `crates/frontend`: Images, fonts, CSS.
- `crates/server`: A minimal Axum server for serving pages.
- `flake.nix`: This doesn't work; ignore it.
## License
MIT