Re-order Pixi commands and update Mac instructions in index.md #124
Conversation
Pixi build commands were listed before the git clone commands which doesn't make sense. Put the commands in more proper sequence as they would be executed. Before, Pixi was described as a good way to compile, then later only CMake is mentioned. Broke up Build section to provide both Pixi and CMake build methods. Mentioned 'brew install pre-commit' as Mac method to install pre-commit
|
Thanks for the PR, @psommerfeld -- I'll ask our resident Pixi expert @oursland to give the changes a look. |
There was a problem hiding this comment.
Your intentions are good and welcomed, but the result is currently more confusing than it was previously.
Before pixi was a single unit which made it easy to follow how to migrate to pixi, but as you say, it was confusing for new people.
With these changes, cmake instructions are broken, visual studio seems to be a requirement on all platforms and instructions are broken in general.
From a pixi-only perspective, the instructions hasn't been changed and are good.
From a more holistic perspective, the instructions needs to be fixed.
It might be good to split the pixi section up, but I think it might be easier and less intrusive to move the forking+cloning to the top? Or what do you think?
| ### Pixi on Windows | ||
|
|
||
| Pixi uses the `conda-forge` packages, including the `compilers` metapackage to bring in the platform-specific compiler support. On Windows, it is expected that Microsoft Visual C++ has been installed and matches the version used by the `conda-forge` team, which is [Visual Studio Community 2019](https://visualstudio.microsoft.com/vs/older-downloads/#visual-studio-2019-and-other-products). |
There was a problem hiding this comment.
This part should be placed at pixi installation, right?
| ### Pixi on Windows | ||
|
|
||
| Pixi uses the `conda-forge` packages, including the `compilers` metapackage to bring in the platform-specific compiler support. On Windows, it is expected that Microsoft Visual C++ has been installed and matches the version used by the `conda-forge` team, which is [Visual Studio Community 2019](https://visualstudio.microsoft.com/vs/older-downloads/#visual-studio-2019-and-other-products). | ||
|
|
||
| The Visual Studio Installer may be used to install Visual Studio Community 2019 alongside newer versions of Visual Studio. Ensure all of the necessary components are installed: | ||
|
|
||
| 1. Open the Visual Studio Installer |
There was a problem hiding this comment.
By removing this Pixi on Windows subsection title, we now have visual studio instructions under general pixi information. It looks like we require visual studio for all platforms, which of cause isn't true.
|
|
||
| 2. Configure FreeCAD for your platform. There are additional steps necessary on Windows outlined in the next subsection. | ||
|
|
||
| `pixi run configure` | ||
|
|
||
| 3. Build FreeCAD |
There was a problem hiding this comment.
You removed all items except for the first item, leaving the numbered list with just one item.
| ### Building with Pixi | ||
|
|
||
| From the FreeCAD base directory, if you have sufficient RAM, run: | ||
|
|
||
| pixi run build | ||
|
|
||
| If your computer has less ram than is necessary to run a compiler per processor core, then you can reduce the number of parallel compiler jobs. For example, if you wish to limit to 4 parallel compiler processes use the following command: | ||
|
|
||
| pixi run build -j 4 | ||
|
|
||
| 5. Run FreeCAD | ||
|
|
||
| pixi run freecad | ||
|
|
||
| In general, there will be no need to re-run the configure command as it will be automatically run by `pixi run build` if needed. However, there may be times in which a git submodule is added or updated. To integrate these changes, the command `pixi run initialize` will run the commands necessary. |
There was a problem hiding this comment.
You start a list here with 5, that's a mistake, right?
| ### Building with CMake | ||
|
|
||
| 6. Run CMake, either in via the CMake GUI or on the command line see the wiki compilation page for your operating system for a detailed list of options. | ||
| 7. CMake will generate project files that can be read by your IDE of choice. See your IDE's documentation for details. In general: |
There was a problem hiding this comment.
You start the list with 6 here, also this part is for setting up the environment, not for building with cmake.
| ## Making Changes | ||
|
|
||
| 8. If you plan on submitting a PR (pull request), create a branch: | ||
|
|
||
| - `git branch fixTheThing` |
There was a problem hiding this comment.
And here you start a numbered list with point 8 and it is also the only item in the list.
|
|
||
| 4. We **strongly** recommend doing an out-of-source build, that is, build FreeCAD and put all generated files in a separate directory. Otherwise, the build files will be spread all over the source code and it will be much harder to sort out one from the other. A build directory can be created outside the FreeCAD source folder or inside: | ||
|
|
||
| - `mkdir build` | ||
| - `cd build` | ||
|
|
||
| 5. Run CMake, either in via the CMake GUI or on the command line see the wiki compilation page for your operating system for a detailed list of options. | ||
| 6. CMake will generate project files that can be read by your IDE of choice. See your IDE's documentation for details. In general: |
There was a problem hiding this comment.
Point 4 should be kept with 5 and 6 as pixi handles location of build for you.
Also, cd build is used to lead the user into the next step, so if reorganized like this, it doesn't make sense
Pixi build commands were listed before the git clone commands which doesn't make sense. Put the commands in more proper sequence as they would be executed. Before, Pixi was described as a good way to compile, then later only CMake is mentioned. Broke up Build section to provide both Pixi and CMake build methods. Mentioned 'brew install pre-commit' as Mac method to install pre-commit