diff --git a/README.md b/README.md index d83d29c570171e8c4209948527a7cac1b7ff1cac..ccb5ec2214b5e50b57917b9f959a101eef0ab2a6 100644 --- a/README.md +++ b/README.md @@ -39,16 +39,22 @@ Here is a small overview about our repository structure, to brief which files yo ## Installing the toolchain -See [toolchain.md](toolchain.md) +For ArchLinux see [build_documentation_arch.md](Repos/build_documentation_arch.md) or for Ubuntu see [build_documentation_ubuntu.md](Repos/build_documentation_ubuntu.md). + +## Source + +* [Sancus](https://distrinet.cs.kuleuven.be/software/sancus/ "KU Leuven Sancus") + ## TODO for README.md / Wiki - [ ] introduction sentences for this README.md / Repo - [X] own repo structure/overview in wiki or README.md - [X] reference from README.md to docker/README.md at docker installation section -- [ ] update (or remove) 'from source' section from README.md (reference to Repos/README.md or Wiki or so..) -- [ ] wiki: installation from source and docker +- [X] update (or remove) 'from source' section from README.md (reference to Repos/README.md or Wiki or so..) +- [X] wiki: installation from source and docker - [ ] docker readme: further documentation on the hello-world example project -- [ ] indicate what was written by you and what is taken 1:1 from other sources (e.g. /Repos/overview.md?) -- [ ] move 'source' subsection from the 'from source' section to end of this file and list all external sources +- [X] indicate what was written by you and what is taken 1:1 from other sources (e.g. /Repos/overview.md?) +- [X] move 'source' subsection from the 'from source' section to end of this file and list all external sources - [ ] TODO list in wiki/main.md + diff --git a/toolchain.md b/Repos/build_documentation_ubuntu.md similarity index 97% rename from toolchain.md rename to Repos/build_documentation_ubuntu.md index 1386ef33665fa6401c0b0794479bff033f3c9d1d..7c52ffa0cee880143f177add7b09091d4cf5ae5c 100644 --- a/toolchain.md +++ b/Repos/build_documentation_ubuntu.md @@ -159,4 +159,3 @@ make install ## Source * [Sancus installation](https://distrinet.cs.kuleuven.be/software/sancus/install.php "KU Leuven Sancus installation") -* [Wiki-ArchLinux: PKGBUILD](https://wiki.archlinux.org/index.php/Pkgbuild "write own PKGBUILD from .deb file") \ No newline at end of file diff --git a/Repos/overview.md b/Repos/overview.md index b5b56e579da42009fd3d7e887d55af8c91ec98bf..62e5d1b47385870a56f31b084a5390b337169cf6 100644 --- a/Repos/overview.md +++ b/Repos/overview.md @@ -2,6 +2,9 @@ ## Repository overview +This file should give an overview about all repositories from the Sancus developer. The description of each repository is quoted from the main page of the repositories. + + ### sancus-main _Top-level repository and build script_ @@ -39,7 +42,7 @@ _Secure compilation of annotated C code to protected modules._ In this directory are the sources for the tools `sancus-cc`, `sancus-ld` and `sancus-crypto`. -There's a _CMakeLists.txt_ which will be called from the __sancus-main__ repositoreis build script to install the tools. +There's a _CMakeLists.txt_ which will be called from the __sancus-main__ repositories build script to install the tools. diff --git a/next_presentation.md b/presentation/next_presentation.md similarity index 100% rename from next_presentation.md rename to presentation/next_presentation.md