mirror of
https://github.com/OrcaSlicer/OrcaSlicer.git
synced 2026-05-19 19:33:47 +00:00
Wiki + Readme: MD security and improvements (#9807)
* Wiki + Readme: MD, security and improvements Standardized MD GitHub Wiki format Removed outdated and malicious links Modularized calibrations Suggested calibration order added Minor bug fixes Image improvements and corrections Added winget commands Completed previous WIPs Added new WIPs Removed obsolete references Visual Changes Co-Authored-By: Noisyfox <timemanager.rick@gmail.com> Co-Authored-By: dewi-ny-je <2866139+dewi-ny-je@users.noreply.github.com> Co-Authored-By: Nico Domino <7415984+ndom91@users.noreply.github.com> Co-Authored-By: Martin Ulmschneider <7497782+mulmschneider@users.noreply.github.com> Co-Authored-By: Rodrigo <162915171+RF47@users.noreply.github.com> * MD Indentation + images update --------- Co-authored-by: Noisyfox <timemanager.rick@gmail.com> Co-authored-by: dewi-ny-je <2866139+dewi-ny-je@users.noreply.github.com> Co-authored-by: Nico Domino <7415984+ndom91@users.noreply.github.com> Co-authored-by: Martin Ulmschneider <7497782+mulmschneider@users.noreply.github.com> Co-authored-by: Rodrigo <162915171+RF47@users.noreply.github.com>
This commit is contained in:
Ian Bassi
@@ -1,39 +1,79 @@
|
||||
# How to Compile
|
||||
# How to Build
|
||||
|
||||
## Windows 64-bit
|
||||
|
||||
This guide is for building your Visual Studio 2022 solution for OrcaSlicer on Windows 64-bit.
|
||||
|
||||
### Tools Required
|
||||
- [Visual Studio 2022](https://visualstudio.microsoft.com/vs/) or Visual Studio 2019
|
||||
|
||||
- [Visual Studio 2022](https://visualstudio.microsoft.com/vs/) or Visual Studio 2019
|
||||
```shell
|
||||
winget install --id=Microsoft.VisualStudio.2022.Professional -e
|
||||
```
|
||||
- [CMake (version 3.31)](https://cmake.org/) — **⚠️ version 3.31.x is mandatory**
|
||||
```shell
|
||||
winget install --id=Kitware.CMake -v "3.31.6" -e
|
||||
```
|
||||
- [Strawberry Perl](https://strawberryperl.com/)
|
||||
```shell
|
||||
winget install --id=StrawberryPerl.StrawberryPerl -e
|
||||
```
|
||||
- [Git](https://git-scm.com/)
|
||||
```shell
|
||||
winget install --id=Git.Git -e
|
||||
```
|
||||
- [git-lfs](https://git-lfs.com/)
|
||||
```shell
|
||||
winget install --id=GitHub.GitLFS -e
|
||||
```
|
||||
|
||||
> [!Tip]
|
||||
> GitHub Desktop (optional): A GUI for Git and Git LFS, which already includes both tools.
|
||||
> ```shell
|
||||
> winget install --id=GitHub.GitHubDesktop -e
|
||||
> ```
|
||||
|
||||
### Instructions
|
||||
|
||||
1. Clone the repository:
|
||||
```sh
|
||||
git clone https://github.com/SoftFever/OrcaSlicer
|
||||
```
|
||||
- If using GitHub Desktop clone the repository from the GUI.
|
||||
- If using the command line:
|
||||
1. Clone the repository:
|
||||
```shell
|
||||
git clone https://github.com/SoftFever/OrcaSlicer
|
||||
```
|
||||
2. Run lfs to download tools on Windows:
|
||||
```shell
|
||||
git lfs pull
|
||||
```
|
||||
2. Open the appropriate command prompt:
|
||||
- For Visual Studio 2019:
|
||||
Open **x64 Native Tools Command Prompt for VS 2019** and run:
|
||||
```sh
|
||||
```shell
|
||||
build_release.bat
|
||||
```
|
||||
- For Visual Studio 2022:
|
||||
Open **x64 Native Tools Command Prompt for VS 2022** and run:
|
||||
```sh
|
||||
```shell
|
||||
build_release_vs2022.bat
|
||||
```
|
||||
3. If successful, you will find the VS 2022 solution file in:
|
||||
```shell
|
||||
build\OrcaSlicer.sln
|
||||
```
|
||||
|
||||
**⚠️ Note 1:** Make sure that CMake version 3.31.x is actually being used. Run `cmake --version` and verify it returns a **3.31.x** version.
|
||||
If you see an older version (e.g. **3.29), it's likely due to another copy in your system's PATH (e.g. from Strawberry Perl).
|
||||
You can run where cmake to check the active paths and rearrange your System Environment Variables > PATH, ensuring the correct CMake (e.g. C:\Program Files\CMake\bin) appears before others like C:\Strawberry\c\bin.
|
||||
> [!IMPORTANT]
|
||||
> Make sure that CMake version 3.31.x is actually being used. Run `cmake --version` and verify it returns a **3.31.x** version.
|
||||
> If you see an older version (e.g. 3.29), it's likely due to another copy in your system's PATH (e.g. from Strawberry Perl).
|
||||
> You can run where cmake to check the active paths and rearrange your System Environment Variables > PATH, ensuring the correct CMake (e.g. C:\Program Files\CMake\bin) appears before others like C:\Strawberry\c\bin.
|
||||
|
||||
**⚠️ Note 2:** ⚠️ Note: If the build fails, try deleting the `build/` and `deps/build/` directories to clear any cached build data. Rebuilding after a clean-up is usually sufficient to resolve most issues.
|
||||
> [!NOTE]
|
||||
> If the build fails, try deleting the `build/` and `deps/build/` directories to clear any cached build data. Rebuilding after a clean-up is usually sufficient to resolve most issues.
|
||||
|
||||
## macOS 64-bit
|
||||
|
||||
### Tools Required
|
||||
|
||||
- Xcode
|
||||
- CMake (version 3.31.x is mandatory)
|
||||
- Git
|
||||
@@ -43,48 +83,55 @@ You can run where cmake to check the active paths and rearrange your System Envi
|
||||
- autoconf
|
||||
- texinfo
|
||||
|
||||
You can install most dependencies via Homebrew:
|
||||
```sh
|
||||
brew install git gettext libtool automake autoconf texinfo
|
||||
```
|
||||
> [!Tip]
|
||||
> You can install most of them by running:
|
||||
> ```shell
|
||||
> brew install gettext libtool automake autoconf texinfo
|
||||
> ```
|
||||
|
||||
Homebrew currently only offers the latest version of CMake (e.g. **4.x**), which is not compatible. To install the required version **3.31.x**, follow these steps:
|
||||
Homebrew currently only offers the latest version of CMake (e.g. **4.X**), which is not compatible. To install the required version **3.31.X**, follow these steps:
|
||||
|
||||
1. Download CMake **3.31.7** from: [https://cmake.org/download/](https://cmake.org/download/)
|
||||
2. Install the application (drag it to `/Applications`).
|
||||
3. Add the following line to your shell configuration file (`~/.zshrc` or `~/.bash_profile`):
|
||||
|
||||
```sh
|
||||
export PATH="/Applications/CMake.app/Contents/bin:$PATH"
|
||||
```
|
||||
|
||||
4. Restart the terminal and check the version:
|
||||
|
||||
```sh
|
||||
cmake --version
|
||||
```
|
||||
|
||||
5. Make sure it reports a **3.31.x** version.
|
||||
|
||||
|
||||
**⚠️ Note 1:** If you've recently upgraded Xcode, be sure to open Xcode at least once and install the required macOS build support.
|
||||
> [!IMPORTANT]
|
||||
> If you've recently upgraded Xcode, be sure to open Xcode at least once and install the required macOS build support.
|
||||
|
||||
### Instructions
|
||||
|
||||
1. Clone the repository:
|
||||
```sh
|
||||
```shell
|
||||
git clone https://github.com/SoftFever/OrcaSlicer
|
||||
cd OrcaSlicer
|
||||
```
|
||||
2. Build the application:
|
||||
```sh
|
||||
```shell
|
||||
./build_release_macos.sh
|
||||
```
|
||||
3. Open the application:
|
||||
```sh
|
||||
open build/arm64/OrcaSlicer/OrcaSlicer.app
|
||||
```shell
|
||||
open build/arm64/OrcaSlicer/OrcaSlicer.app
|
||||
```
|
||||
|
||||
### Debugging in Xcode
|
||||
|
||||
To build and debug directly in Xcode:
|
||||
|
||||
1. Open the Xcode project:
|
||||
```sh
|
||||
```shell
|
||||
open build/arm64/OrcaSlicer.xcodeproj
|
||||
```
|
||||
2. In the menu bar:
|
||||
@@ -99,23 +146,28 @@ To build and debug directly in Xcode:
|
||||
### Using Docker (Recommended)
|
||||
|
||||
#### Dependencies
|
||||
|
||||
- Docker
|
||||
- Git
|
||||
|
||||
#### Instructions
|
||||
```sh
|
||||
git clone https://github.com/SoftFever/OrcaSlicer
|
||||
cd OrcaSlicer
|
||||
./DockerBuild.sh
|
||||
./DockerRun.sh
|
||||
|
||||
```shell
|
||||
git clone https://github.com/SoftFever/OrcaSlicer && cd OrcaSlicer && ./DockerBuild.sh && ./DockerRun.sh
|
||||
```
|
||||
|
||||
To troubleshoot common Docker-related errors, refer to the comments in `DockerRun.sh`.
|
||||
> [!Note]
|
||||
> To troubleshoot common Docker-related errors, refer to the comments in
|
||||
> ```shell
|
||||
> DockerRun.sh
|
||||
> ```
|
||||
|
||||
## Ubuntu
|
||||
|
||||
### Dependencies
|
||||
|
||||
All required dependencies will be installed automatically by the provided shell script, including:
|
||||
|
||||
- libmspack-dev
|
||||
- libgstreamerd-3-dev
|
||||
- libsecret-1-dev
|
||||
@@ -134,7 +186,8 @@ All required dependencies will be installed automatically by the provided shell
|
||||
- texinfo
|
||||
|
||||
### Instructions
|
||||
```sh
|
||||
|
||||
```shell
|
||||
sudo ./BuildLinux.sh -u # Install dependencies
|
||||
./BuildLinux.sh -dsi # Build OrcaSlicer
|
||||
```
|
||||
```
|
||||
Reference in New Issue
Block a user