Skip to content

Commit

Permalink
intro to cmake and prerequisites
Browse files Browse the repository at this point in the history
  • Loading branch information
code4yonglei committed Sep 2, 2024
1 parent a1524c2 commit ef28fa6
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 5 deletions.
4 changes: 2 additions & 2 deletions content/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@

# -- Project information -----------------------------------------------------

project = "LESSON NAME"
copyright = "2021, The contributors"
project = "Introduction to CMake"
copyright = "2024, EuroCC National Competence Centre Sweden"
author = "The contributors"
github_user = "ENCCS"
github_repo_name = "" # auto-detected from dirname if blank
Expand Down
26 changes: 23 additions & 3 deletions content/index.rst
Original file line number Diff line number Diff line change
@@ -1,13 +1,33 @@
LESSON NAME
Introduction to CMake
===========

Check warning on line 2 in content/index.rst

View workflow job for this annotation

GitHub Actions / Build

Title underline too short.

Intro

CMake is a language-agnostic, cross-platform build tool and is nowadays the *de facto* standard, with large projects using it to reliably build, test, and deploy their codebases.

CMake is not a build system itself, but it generates another system's build files.

In this workshop, you will learn
- Write a CMake build system for C/C++ and Fortran projects producing libraries and/or executables.
- Run tests for your code with `CTest`.
- Ensure your build system will work on different platforms.
- (optional) Detect and use external dependencies in your project.
- (optional) Safely and effectively build mixed-language projects (Python+C/C++, Python+Fortran, Fortran+C/C++)



.. prereq::

prerequisites
Before attending this workshop, please make sure that you have access to a computer with a compiler for your favorite programming language and a recent version of CMake.

If you have access to a supercomputer (e.g. a `NAISS system <https://www.naiss.se/>`_) with a compute allocation you can use that during the workshop. Any questions on how to use a particular HPC resource should be directed to the appropriate support desk.

You can also use your own computer for this workshop, provided that it has the necessary tools installed.

Check warning on line 24 in content/index.rst

View workflow job for this annotation

GitHub Actions / Build

unknown document: 'setup'

Check warning on line 24 in content/index.rst

View workflow job for this annotation

GitHub Actions / Build

unknown document: 'setup'

Check warning on line 24 in content/index.rst

View workflow job for this annotation

GitHub Actions / Build

unknown document: 'setup'
- If you do not already have these installed, we recommend that you set up an isolated software environment using ``conda``.
- For Windows computers we recommend to use the ``Windows Subsystem for Linux (WSL)``. Detailed instructions can be found
on the :doc:`setup` page.






Expand Down

0 comments on commit ef28fa6

Please sign in to comment.