Skip to content

Re-order Pixi commands and update Mac instructions in index.md #124

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Re-order Pixi commands and update Mac instructions in index.md #124

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
66 changes: 36 additions & 30 deletions gettingstarted/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,28 +38,6 @@ One of the easiest ways of creating a standalone FreeCAD build environment with
- Windows (PowerShell): `iwr -useb https://pixi.sh/install.ps1 | iex`
- Linux/macOS: `curl -fsSL https://pixi.sh/install.sh | bash`

2. Configure FreeCAD for your platform. There are additional steps necessary on Windows outlined in the next subsection.

`pixi run configure`

3. Build FreeCAD
Comment on lines 40 to -45
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You removed all items except for the first item, leaving the numbered list with just one item.


`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`

4. 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.

### 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
Comment on lines -59 to 43
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Expand All @@ -77,31 +55,59 @@ The Visual Studio Installer may be used to install Visual Studio Community 2019
2. Clone your fork: for example, on the command line you can use `git clone --recurse-submodules https://github.com/YourUsername/FreeCAD FreeCAD-src`
3. Set up `pre-commit` (our automatic code-formatter and checker):


- Install `pre-commit` (either using your system package manager or pip):
- Debian/Ubuntu: `apt install pre-commit`
- Fedora: `dnf install pre-commit` (Fedora)
- Fedora: `dnf install pre-commit`
- Arch Linux: `pacman -S pre-commit`
- Mac: `brew install pre-commit`
- Other (pip in PATH): `pip install pre-commit`
- Other (pip not in PATH): `python -m pip install pre-commit`
- On a command line, change into your FreeCAD clone, e.g. `cd FreeCAD-src`
- Run `pre-commit install` (or `python -m pre-commit install`, depending on your PATH)



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:
Comment on lines -91 to -98
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

If you are using Pixi, configure it. From the FreeCAD base directory:

- `pixi run configure`

### 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).
Comment on lines +77 to +79
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This part should be placed at pixi installation, right?


## Building

### 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.
Comment on lines +83 to +97
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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:
Comment on lines +99 to +102
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You start the list with 6 here, also this part is for setting up the environment, not for building with cmake.


- On Linux, compile with a command like `cmake --build /path/to/FreeCAD-src` run from your build directory ( or `cmake --build ..` if your build directory is inside FreeCAD-src).
- On Windows with Visual Studio, build the "ALL_BUILD target" (you will have to change the path to the final executable the first time you try to run that target).
- On Mac on the command line use `cmake --build /path/to/FreeCAD-src` from your build directory, or if using CLion be sure to "Build All" the first time you run.

7. If you plan on submitting a PR, create a branch:
## Making Changes

8. If you plan on submitting a PR (pull request), create a branch:

- `git branch fixTheThing`
Comment on lines +108 to 112
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And here you start a numbered list with point 8 and it is also the only item in the list.

- `git checkout fixTheThing` (or both commands in one go: `git checkout -b fixTheThing`)
Expand All @@ -111,7 +117,7 @@ The Visual Studio Installer may be used to install Visual Studio Community 2019
- [Visual Studio Code](./VSCode.md)
- [CLion](./CLion.md)

## Submitting a PR
## Submitting a PR (Pull Request)

The basic process is:

Expand Down