Dev doc

Welcome to the developer documentation of Shamrock

Contents

• IDE development setup
  • Repo setup
  • VSCode (and derivatives, e.g. Cursor, Vscodium, …)
  • Neovim (Lazyvim)
• Building the documentation
  • Repo setup
  • Building the Sphinx documentation
  • Building the doxygen doc
• Testing
  • Running Unit Tests
  • Writing a Unit Test
• Shamrock primitive types
  • Literals
• Profiling
  • Shamrock custom profiling
  • Nvidia profiling
• Release process
  • Changing the version
  • The release branch
  • Creating the release