add more stuff

README.md

 # Sustainable Software Engineering
 
-TODO
 
-Link to lecture material
+## Installation
+
+1. **Clone the Repository:**
+   ```
+   git clone https://github.com/username/project-name.git
+   ```
+2. **Navigate to the Project Directory:**
+   ```
+   cd project-name
+   ```
+
+## Running the Project
+
+1. **Start Julia:**
+   Open Julia REPL by running `julia` in your terminal.
+
+2. **Activate and Instantiate the Project:**
+   ```julia
+   using Pkg
+   Pkg.activate(".")
+   Pkg.instantiate()
+   ```
+
+3. **Run the Project:**
+   ```julia
+   using SustainableSoftwareEngineering
+   add(1,2)
+   # 3
+   ```
+
+## Test the Project
+
+1. **Start Julia:**
+   Open Julia REPL by running `julia` in your terminal.
+
+2. **Activate, Instantiate and Test the Project:**
+   ```julia
+   using Pkg
+   Pkg.activate(".")
+   Pkg.instantiate()
+   Pkg.test()
+   ```
+
+## Build Documentation of Project
+
+1. **Start Julia:**
+   Open Julia REPL by running `julia` in your terminal.
+
+2. **Activate, Instantiate and Test the Project:**
+   ```julia
+   using Pkg
+   Pkg.activate(".")
+   Pkg.instantiate()
+   include("docs/make.jl")
+   ```
+
+3. **Open in browser**
+   ```bash
+   # e.g.
+   firefox docs/build/index.html
+   ```
+
+## Troubleshooting
+
+- Note that the following throws an error:
+```julia
+using SustainableSoftwareEngineering
+add("a","b")
+# ERROR: ...
+```
+
+## Example Files
+
+- See [`examples` Folder](./examples)
+
+## Contact
+- Lambert Theisen
+- `lambert.theisen@ians.uni-stuttgart.de`

docs/make.jl

 push!(LOAD_PATH,"../src/")
 push!(LOAD_PATH,"src/")
 
-using Documenter, SustainableSoftwareEngineering
+using SustainableSoftwareEngineering
+using Documenter
 
 makedocs(
   sitename="SustainableSoftwareEngineering.jl",
   remotes = nothing,
   pages = Any[
         "Home" => "index.md",
+        "API" => "api.md",
         # add all lecture material
         joinpath.(
           "lecture",

docs/src/api.md

+# Developer Documentation
+
+## API
+
+```@autodocs
+Modules = [SustainableSoftwareEngineering]
+Private = true
+Order   = [:function, :type]
+```
+
+## Index
+
+```@index
+```

docs/src/index.md

-# Example.jl Documentation
+# SustainableSoftwareEngineering.jl
 
-Hi
+## Table of Contents
+
+```@contents
+```

docs/src/lecture/1-git.md

-# Introduction to Git
+# Version Control: Introduction to Git
 
 ## What is Git?
 
@@ -37,7 +37,4 @@ git config --global user.email "your.email@example.com"
 - https://aeturrell.github.io/coding-for-economists/wrkflow-version-control.html
 - https://merely-useful.tech/py-rse/git-cmdline.html
 
-TODO
-Addd some images to visualize
-Add further reading
 Explain gitignore and make example

docs/src/lecture/2-julia_project_structure.md

-# Julia Project Structure
+# Julia: Project Structure
 
 This lecture focuses on the structure and management of Julia-specific projects. We will cover how to create a project using the Package Manager, the purpose of various directories and files, and best practices for maintaining a Julia project.
 

docs/src/lecture/3-julia_documentation.md

-# Julia Documentation
+# Julia: Documentation
 
 In this lecture, we'll explore how to effectively document Julia code. We'll cover the use of doc strings, introduce Documenter.jl for creating comprehensive documentation, and discuss how to build and host a documentation website.
 

docs/src/lecture/4-julia_testing.md

 
-# Testing in Julia
+# Julia: Testing
 
 This lecture aims to provide a comprehensive guide on testing practices in Julia. We will explore the importance of unit tests, delve into coverage aspects, and discuss the integration of automatic testing using continuous integration (CI) tools.
 

src/Addition.jl

 export add
 
 """
-add(x, y)
+  add(x, y)
 
 Compute the sum of `x` and `y`.
 
@@ -9,10 +9,17 @@ Compute the sum of `x` and `y`.
 - `x::Int`: The first integer
 - `y::Int`: The second integer
 
+## Mathematical formula
+
+```math
+  (x,y) \\mapsto x+y
+```
+
 # Examples
 ```julia
 julia> add(2, 3)
 5
+```
 """
 function add(x::Int, y::Int)
   return x + y