Skip to content

Commit

Permalink
fixup the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jupyterkat committed Nov 2, 2023
1 parent 917f745 commit ac1e682
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
Rust-based atmospherics for Space Station 13 using [auxtools](https://github.com/willox/auxtools).
Rust-based atmospherics for Space Station 13 using [byondapi](https://github.com/spacestation13/byondapi-rs).

The compiled binary on Citadel is compiled for Citadel's CPU, which therefore means that it uses [AVX2 fused-multiply-accumulate](https://en.wikipedia.org/wiki/Advanced_Vector_Extensions#Advanced_Vector_Extensions_2). Yes, really. If you have issues, compile it yourself, via `cargo rustc --target=i686-pc-windows-msvc --release --features "all_reaction_hooks katmos" -- -C target-cpu=native`. It has to be 32-bit, mind.
The compiled binary on Citadel is compiled for Citadel's CPU, which therefore means that it uses [AVX2 fused-multiply-accumulate](https://en.wikipedia.org/wiki/Advanced_Vector_Extensions#Advanced_Vector_Extensions_2).

Binaries in releases are without these optimizations for compatibility. But it runs slower and you might still run into issues, in that case, please build the project yourself.

You can build auxmos like any rust project, though you're gonna need clang installed. And `LIBCLANG_PATH` environment variable set to the bin path of clang in case of windows. Auxmos only supports `i686-unknown-linux-gnu` or `i686-pc-windows-msvc` targets on the build.

The `master` branch is to be considered unstable; use the releases if you want to make sure it actually works. [The latest release is here](https://github.com/Putnam3145/auxmos/releases/latest).

0 comments on commit ac1e682

Please sign in to comment.