Skip to content
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.

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

Add linux build instructions #60

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

ebrahimebrahim
Copy link
Contributor

@ebrahimebrahim ebrahimebrahim commented Jun 19, 2024

  • Add linux build instructions
  • Tweak windows build instructions
    • Rename to BUILD_WINDOWS.md
    • Remove instruction to email for access; see commit message for reasoning.
    • Don't say it will take 3 hours, be more vague.

Close #56

{{cookiecutter.project_name}}/BUILD_LINUX.md Outdated Show resolved Hide resolved
{{cookiecutter.project_name}}/BUILD_LINUX.md Outdated Show resolved Hide resolved
{{cookiecutter.project_name}}/BUILD_LINUX.md Outdated Show resolved Hide resolved
-S {{cookiecutter.github_project}} \
-B {{cookiecutter.github_project}}-SuperBuild-Release

make -j<N>
Copy link

Choose a reason for hiding this comment

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

It could be best as is, though my usual approach is instead

cmake --build . -j<N>

(Actually, I usually also throw in a --config Release for good measure, but I have no idea whether that is useful.)


## Package

From the inner build folder:
From the _inner build_ folder:

```sh
make package
Copy link

@Leengit Leengit Jun 20, 2024

Choose a reason for hiding this comment

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

Likwwise, it could be best as is, though my usual approach is instead from the superbuild folder

cmake --build . --target package -j<N>

(Also usually including --config Release.)

Copy link

Choose a reason for hiding this comment

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

Sorry, I'm wrong. I do that from the inner build folder.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I guess the advantage is that it's a more platform-independent command.

I like that aspect of it, but I also prefer a simple and easy to remember command.

Copy link

@Leengit Leengit left a comment

Choose a reason for hiding this comment

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

Let's merge this?

@jcfr
Copy link
Collaborator

jcfr commented Aug 20, 2024

Let's merge this?

Thanks for the reminder, we will integrate this after #62. Since it adds support for running mirror-prettier1 pre-commit hook for markdown files, it will ensure the new file BUILD_LINUX.md is consistently formatted.

Footnotes

  1. https://github.com/rbubley/mirrors-prettier

@ebrahimebrahim ebrahimebrahim force-pushed the add_linux_build_instructions branch 2 times, most recently from a0fbf42 to 46927a4 Compare August 20, 2024 17:20
ebrahimebrahim and others added 6 commits August 20, 2024 13:26
This makes room for linux build instructions to be added
This doesn't make sense for a  number of reasons:
- Not every organization has a domain name like that or does emails
  like that with first and last names.
- Email is not always the preferred mode of contact.
- If someone can read this BUILD_WINDOWS.md document, then they already
  have read access to the repo and do not need to request further access.
  Write access is not needed for cloning and building.
Build time depends on many factors and evolves as Slicer does
Co-authored-by: Jean-Christophe Fillion-Robin <[email protected]>
It's only needed on ubuntu 20.04 pretty much so it should not be there
in the main instruction.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Is there a build documentation for Linux ?
3 participants