Skip to content

Commit

Permalink
build-from-source: Remove mention of needing to install SFML
Browse files Browse the repository at this point in the history
  • Loading branch information
crumblingstatue committed Oct 16, 2024
1 parent 5aa80c0 commit 91b8167
Show file tree
Hide file tree
Showing 5 changed files with 9 additions and 24 deletions.
7 changes: 1 addition & 6 deletions docs/getting-started/build-from-source.html
Original file line number Diff line number Diff line change
Expand Up @@ -180,21 +180,16 @@ <h1 id="building-from-source"><a class="header" href="#building-from-source">Bui
<h2 id="prerequisites"><a class="header" href="#prerequisites">Prerequisites</a></h2>
<ul>
<li>Up-to-date nightly <a href="https://www.rust-lang.org/">Rust</a></li>
<li><a href="https://www.sfml-dev.org/">SFML</a> 2.5</li>
<li>A C++ compiler for building some native dependencies (GCC, Clang, MSVC)</li>
<li>A C++ compiler and <a href="https://cmake.org/">CMake</a> for building some native dependencies.</li>
</ul>
<h2 id="steps"><a class="header" href="#steps">Steps</a></h2>
<ol>
<li>Get the latest source zip or tarball from the <a href="https://github.com/crumblingstatue/hexerator/releases">releases page</a>.</li>
<li>Extract the source somewhere</li>
<li>Make sure you have SFML set up correctly. You might need to <a href="https://github.com/jeremyletang/rust-sfml#environment-variables">set some environment variables</a>.</li>
<li>Ensure you're using an up-to-date nightly rust. Hexerator is using nightly Rust for the time being.</li>
<li>Open up a terminal, and change to the directory where you extracted Hexerator.</li>
<li>Run <code>cargo build --release</code></li>
<li>There will be a hexerator binary built in the <code>target/release</code> directory.</li>
<li>On windows, you might need to copy over the <code>.dll</code> files from the <code>bin</code> folder of your SFML location.
Do this if you're getting .dll related errors.
Try copying the .dll files to wherever you will be running Hexerator from.</li>
</ol>
<p>If you run into trouble you can't seem to solve, you can ask for help at <a href="https://github.com/crumblingstatue/hexerator/discussions">https://github.com/crumblingstatue/hexerator/discussions</a>.</p>

Expand Down
7 changes: 1 addition & 6 deletions docs/print.html
Original file line number Diff line number Diff line change
Expand Up @@ -335,21 +335,16 @@ <h2 id="hardware-requirements"><a class="header" href="#hardware-requirements">H
<h2 id="prerequisites"><a class="header" href="#prerequisites">Prerequisites</a></h2>
<ul>
<li>Up-to-date nightly <a href="https://www.rust-lang.org/">Rust</a></li>
<li><a href="https://www.sfml-dev.org/">SFML</a> 2.5</li>
<li>A C++ compiler for building some native dependencies (GCC, Clang, MSVC)</li>
<li>A C++ compiler and <a href="https://cmake.org/">CMake</a> for building some native dependencies.</li>
</ul>
<h2 id="steps"><a class="header" href="#steps">Steps</a></h2>
<ol>
<li>Get the latest source zip or tarball from the <a href="https://github.com/crumblingstatue/hexerator/releases">releases page</a>.</li>
<li>Extract the source somewhere</li>
<li>Make sure you have SFML set up correctly. You might need to <a href="https://github.com/jeremyletang/rust-sfml#environment-variables">set some environment variables</a>.</li>
<li>Ensure you're using an up-to-date nightly rust. Hexerator is using nightly Rust for the time being.</li>
<li>Open up a terminal, and change to the directory where you extracted Hexerator.</li>
<li>Run <code>cargo build --release</code></li>
<li>There will be a hexerator binary built in the <code>target/release</code> directory.</li>
<li>On windows, you might need to copy over the <code>.dll</code> files from the <code>bin</code> folder of your SFML location.
Do this if you're getting .dll related errors.
Try copying the .dll files to wherever you will be running Hexerator from.</li>
</ol>
<p>If you run into trouble you can't seem to solve, you can ask for help at <a href="https://github.com/crumblingstatue/hexerator/discussions">https://github.com/crumblingstatue/hexerator/discussions</a>.</p>
<div style="break-before: page; page-break-before: always;"></div><h1 id="ui-overview"><a class="header" href="#ui-overview">Ui Overview</a></h1>
Expand Down
2 changes: 1 addition & 1 deletion docs/searchindex.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/searchindex.json

Large diffs are not rendered by default.

15 changes: 5 additions & 10 deletions hexerator/src/getting-started/build-from-source.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,20 +3,15 @@
## Prerequisites

- Up-to-date nightly [Rust](https://www.rust-lang.org/)
- [SFML](https://www.sfml-dev.org/) 2.5
- A C++ compiler for building some native dependencies (GCC, Clang, MSVC)
- A C++ compiler and [CMake](https://cmake.org/) for building some native dependencies.

## Steps

1. Get the latest source zip or tarball from the [releases page](https://github.com/crumblingstatue/hexerator/releases).
2. Extract the source somewhere
3. Make sure you have SFML set up correctly. You might need to [set some environment variables](https://github.com/jeremyletang/rust-sfml#environment-variables).
4. Ensure you're using an up-to-date nightly rust. Hexerator is using nightly Rust for the time being.
5. Open up a terminal, and change to the directory where you extracted Hexerator.
6. Run `cargo build --release`
7. There will be a hexerator binary built in the `target/release` directory.
8. On windows, you might need to copy over the `.dll` files from the `bin` folder of your SFML location.
Do this if you're getting .dll related errors.
Try copying the .dll files to wherever you will be running Hexerator from.
3. Ensure you're using an up-to-date nightly rust. Hexerator is using nightly Rust for the time being.
4. Open up a terminal, and change to the directory where you extracted Hexerator.
5. Run `cargo build --release`
6. There will be a hexerator binary built in the `target/release` directory.

If you run into trouble you can't seem to solve, you can ask for help at <https://github.com/crumblingstatue/hexerator/discussions>.

0 comments on commit 91b8167

Please sign in to comment.