Improve, restructure documentation and add screenshot

2020-10-20 12:13:30 +02:00
parent 92be9d56ee
commit d25dd41ccf
18 changed files with 3 additions and 1 deletions
--- a/README.md
+++ b/README.md
@ -5,6 +5,8 @@ CodeOcean
 [![Code Climate](https://codeclimate.com/github/openHPI/codeocean/badges/gpa.svg)](https://codeclimate.com/github/openHPI/codeocean)
 [![Test Coverage](https://codeclimate.com/github/openHPI/codeocean/badges/coverage.svg)](https://codeclimate.com/github/openHPI/codeocean)

+![Learner Interface](docs/implement.png)
+
 ## Introduction

 CodeOcean is an educational, web-based execution and development environment for practical programming exercises designed for the use in Massive Open Online Courses (MOOCs). 
@ -20,7 +22,7 @@ CodeOcean is mainly used in the context of MOOCs (such as those offered on openH

 ## Development Setup

-Please refer to the [Local Setup Guide](LOCAL_SETUP.md) for more details. 
+Please refer to the [Local Setup Guide](docs/LOCAL_SETUP.md) for more details. 

 ### Mandatory Steps

--- a/docs/LOCAL_SETUP.md
+++ b/docs/LOCAL_SETUP.md
--- a/docs/codeocean-dockerconfig.md
+++ b/docs/codeocean-dockerconfig.md
--- a/docs/debian_installer/setup_debian_1_install_postgres.sh
+++ b/docs/debian_installer/setup_debian_1_install_postgres.sh
--- a/docs/debian_installer/setup_debian_2_install_docker.sh
+++ b/docs/debian_installer/setup_debian_2_install_docker.sh
--- a/docs/debian_installer/setup_debian_3_install_depencies_and_utils.sh
+++ b/docs/debian_installer/setup_debian_3_install_depencies_and_utils.sh
--- a/docs/debian_installer/setup_debian_4_install_guest_additions.sh
+++ b/docs/debian_installer/setup_debian_4_install_guest_additions.sh
--- a/docs/debian_installer/setup_debian_5_mount_shared_folder.sh
+++ b/docs/debian_installer/setup_debian_5_mount_shared_folder.sh
--- a/docs/debian_installer/setup_debian_6_setup_codeocean.sh
+++ b/docs/debian_installer/setup_debian_6_setup_codeocean.sh
--- a/docs/debian_installer/setup_debian_7_create_tables.sh
+++ b/docs/debian_installer/setup_debian_7_create_tables.sh
--- a/docs/debian_installer/setup_debian_vm.sh
+++ b/docs/debian_installer/setup_debian_vm.sh
--- a/docs/implement.png
+++ b/docs/implement.png
--- a/docs/webpython/Dockerfile
+++ b/docs/webpython/Dockerfile
--- a/docs/webpython/Makefile
+++ b/docs/webpython/Makefile
--- a/docs/webpython/README.md
+++ b/docs/webpython/README.md
--- a/docs/webpython/assess.py
+++ b/docs/webpython/assess.py
--- a/docs/webpython/turtle.py
+++ b/docs/webpython/turtle.py
--- a/docs/webpython/webpython.py
+++ b/docs/webpython/webpython.py