SustainableSoftwareEngineering.jl

Table of Contents

• Developer Documentation
• • API
  • Index
• SustainableSoftwareEngineering.jl
• • Table of Contents
• Basics of Sustainable Software Engineering in Julia
• • Basic Introduction to Linux Shell
  • Introduction to Markdown
  • Integrated Development Environment (IDE)
  • Further Reading/References
• Version Control: Introduction to Git
• • What is Git?
  • Key Features of Git
  • Basic Git Commands
  • Basic Git Workflow
  • Gitignore
  • Getting Started
  • Further reading
• Julia: Project Structure
• • Creating a Project Using Package Manager
  • Key Folders in a Julia Project
  • README File
  • Project.toml and Manifest.toml
  • Optional Files
• Julia: Documentation
• • Doc Strings in Julia
  • Code Example: Writing a Doc String
  • Introduction to Documenter.jl
  • Including Additional Markdown Files
  • Rendering Examples Automatically
  • Inspecting the resulting index.html
  • Optional: Building a Documentation Website
• Julia: Testing
• • Importance of Testing
  • Unit Tests in Julia
  • Invoking the Written Tests
  • Optional
  • Further reading