diff --git a/doc/Home.md b/doc/Home.md index 6c3d6bf72..3f911caa8 100644 --- a/doc/Home.md +++ b/doc/Home.md @@ -1,12 +1,7 @@ -Welcome to the documentation wiki! +Welcome to the OrcaSlicer WIKI! We have divided it roughly into the following pages: * [Calibration](wiki/Calibration) -* [How to build - Linux et al](wiki/How-to-build---Linux-et-al) -* [How to build Mac OS](wiki/How-to-build---Mac-OS) -* [How to build Windows](wiki/How-to-build---Windows) -* [Localization guide](wiki/Localization_guide) -* [release_notes_cn](wiki/release_notes_cn) -* [release_notes_en](wiki/release_notes_en) * [Seam](wiki/Seam) +* [How to build Orca Slicer](wiki/How-to-build) diff --git a/doc/How to build b/doc/How to build new file mode 100644 index 000000000..a7c05b0f5 --- /dev/null +++ b/doc/How to build @@ -0,0 +1,11 @@ +# How to compile +- Windows 64-bit + - Tools needed: Visual Studio 2019, Cmake, git, Strawberry Perl. + - Run `build_release.bat` in `x64 Native Tools Command Prompt for VS 2019` + +- Mac 64-bit + - Tools needed: Xcode, Cmake, git, gettext + - run `build_release_macos.sh` + +- Ubuntu + - run `BuildLinux.sh -udisr` \ No newline at end of file diff --git a/doc/How to build - Linux et al.md b/doc/How to build - Linux et al.md deleted file mode 100644 index 0c276bce0..000000000 --- a/doc/How to build - Linux et al.md +++ /dev/null @@ -1,4 +0,0 @@ - -# Building Orca Slicer on UNIX/Linux - -Currently Linux version is not verified, you can try it referring to [PrusaSlicer'S linux building guide](https://github.com/prusa3d/PrusaSlicer/blob/master/doc/How%20to%20build%20-%20Linux%20et%20al.md) \ No newline at end of file diff --git a/doc/How to build - Mac OS.md b/doc/How to build - Mac OS.md deleted file mode 100644 index 43009d32f..000000000 --- a/doc/How to build - Mac OS.md +++ /dev/null @@ -1,41 +0,0 @@ - -# Building Orca Slicer on Mac OS - -## Enviroment setup -Install Following tools: -- Xcode from app store -- Cmake -- git -- gettext - -Cmake, git, gettext can be installed from brew(brew install cmake git gettext) - -## building the deps -You need to build the dependence of OrcaSlicer first. (Only needs for the first time) - -Suppose you download the codes into /Users/_username_/work/projects/BambuStudio -create a directory to store the dependence built: /Users/_username_/work/projects/OrcaSlicer_dep -**(Please make sure to replace the username with the one on your computer)** - -`cd BambuStudio/deps` -`mkdir build;cd build` - -for arm64 architecture -`cmake ../ -DDESTDIR="/Users/username/work/projects/OrcaSlicer_dep" -DOPENSSL_ARCH="darwin64-arm64-cc"` -for x86 architeccture -`cmake ../ -DDESTDIR="/Users/username/work/projects/OrcaSlicer_dep" -DOPENSSL_ARCH="darwin64-x86_64-cc"` -`make -jN` (N can be a number between 1 and the max cpu number) - -## building the Orca Slicer -create a directory to store the installed files at /Users/username/work/projects/BambuStudio/install_dir -`cd BambuStudio` -`mkdir install_dir` -`mkdir build;cd build` - -building it use cmake -`cmake .. -DBBL_RELEASE_TO_PUBLIC=1 -DCMAKE_PREFIX_PATH="/Users/username/work/projects/OrcaSlicer_dep/usr/local" -DCMAKE_INSTALL_PREFIX="../install_dir" -DCMAKE_BUILD_TYPE=Release -DCMAKE_MACOSX_RPATH=ON -DCMAKE_INSTALL_RPATH="/Users/username/work/projects/OrcaSlicer_dep/usr/local" -DCMAKE_MACOSX_BUNDLE=on` -`cmake --build . --target install --config Release -jN` - -building it use xcode -`cmake .. -GXcode -DBBL_RELEASE_TO_PUBLIC=1 -DCMAKE_PREFIX_PATH="/Users/username/work/projects/OrcaSlicer_dep/usr/local" -DCMAKE_INSTALL_PREFIX="../install_dir" -DCMAKE_BUILD_TYPE=Release -DCMAKE_MACOSX_RPATH=ON -DCMAKE_INSTALL_RPATH="/Users/username/work/projects/OrcaSlicer_dep/usr/local" -DCMAKE_MACOSX_BUNDLE=on` -then building it using Xcode \ No newline at end of file diff --git a/doc/How to build - Windows.md b/doc/How to build - Windows.md deleted file mode 100644 index cfac39563..000000000 --- a/doc/How to build - Windows.md +++ /dev/null @@ -1,35 +0,0 @@ -# Building Orca Slicer on Windows - -## Enviroment setup -Install Following tools: -- Visual Studio Community 2019 from [visualstudio.microsoft.com/vs/](https://visualstudio.microsoft.com/vs/) (Older versions are not supported as Orca Slicer requires support for C++17, and newer versions should also be ok); -- Cmake from [cmake.org](https://cmake.org/download/) -- Git from [gitforwindows.org](https://gitforwindows.org/) -- Perl from [strawberryperl](https://strawberryperl.com/) - -## building the deps -Suppose you download the codes into D:/work/Projects/BambuStudio -create a directory to store the dependence built: D:/work/Projects/OrcaSlicer_dep - -`cd BambuStudio/deps` -`mkdir build;cd build` -`cmake ../ -G "Visual Studio 16 2019" -DDESTDIR="D:/work/Projects/OrcaSlicer_dep" -DCMAKE_BUILD_TYPE=Release` -`msbuild /m ALL_BUILD.vcxproj` - -It takes "00:14:27.37" to finish it on my machine (11th Gen Intel(R) Core(TM) i9-11900 @2.50GHz 2.50 GHz, with 32.0 GB DDR) - -## building the Orca Slicer -create a directory to store the installed files at D:/work/Projects/BambuStudio/install_dir -`cd BambuStudio` -`mkdir install_dir` -`mkdir build;cd build` - -set -DWIN10SDK_PATH to your windows sdk path(for example: C:/Program Files (x86)/Windows Kits/10/Include/10.0.19041.0) in below command: -`cmake .. -G "Visual Studio 16 2019" -DBBL_RELEASE_TO_PUBLIC=1 -DCMAKE_PREFIX_PATH="D:/work/Projects/OrcaSlicer_dep/usr/local" -DCMAKE_INSTALL_PREFIX="../install_dir" -DCMAKE_BUILD_TYPE=Release -DWIN10SDK_PATH="C:/Program Files (x86)/Windows Kits/10/Include/10.0.19041.0"` - -then build it using command -`cmake --build . --target install --config Release` - -or building it under the Visual Studio 2019 -(set the OrcaSlicer_app_gui as start project) -![image](https://user-images.githubusercontent.com/106916061/179185940-06135b47-f2a4-415a-9be4-666680fa0f9a.png) \ No newline at end of file diff --git a/doc/release_notes_cn.md b/doc/release_notes_cn.md deleted file mode 100644 index b5c3b9b39..000000000 --- a/doc/release_notes_cn.md +++ /dev/null @@ -1,18 +0,0 @@ -**新功能** -1. 3D文字工具 -2. 对象和拷贝间的数据共享 -3. 参数表格 -4. 用户指南 -5. 支持Arachne特性 - -**改进** -1. 支持导出通用的3mf格式,兼容其他切片软件 -2. 优化混合支撑和树状支撑的生成速度 -3. 支持不停靠工具头的延迟摄影 -4. 支持纹理PEI热床 -5. 支持导入和导出预设 -6. 支持随机位置的接缝设置 -7. 支持匈牙利语 -8. 一些关键问题修复 - -详细信息请查看:https://github.com/bambulab/BambuStudio/releases diff --git a/doc/release_notes_en.md b/doc/release_notes_en.md deleted file mode 100644 index 89d801b2d..000000000 --- a/doc/release_notes_en.md +++ /dev/null @@ -1,18 +0,0 @@ -**New Features** -1. 3D text tool -2. Shared data between an object and its copies -3. Parameter table -4. User manual -5. Arachne feature - -**Improvements** -1. Added support for exporting generic 3mf that is compatible with other slicers -2. Optimized the performance of hybrid and tree support -3. Added traditional timelapse mode -4. Added support for Textured PEI plate -5. Added support for export/import preset -6. Added random seam position -7. Added Magyar translations -8. Fixed some known bugs - -For details, please check https://github.com/bambulab/BambuStudio/releases