Make root README useful

README.md

@@ -1,4 +1,4 @@
-# Your Project Name
+# IOTTB
 
 Hello! This is the README file that accompanies the Gitlab repository for your Bachelor or Master thesis. You'll need to update this README as you work on your thesis to reflect relevant information about your thesis.
 
@@ -6,29 +6,28 @@ Hello! This is the README file that accompanies the Gitlab repository for your B
 
 ## Organization of the repository
 - **code** folder: holds source code
-- **data** folder: holds (input) data required for the project. If your input data files are larger than 100MB, create a sample data file smaller than 100MB and commit the sample instead of the full data file. Include a note explaining how the full data can be retrieved.
+- **data** folder: Holds no relevant data for this thesis. Files in here where used for debugging and testing.
 - **results** folder: holds results files generated as part of the project
-- **thesis** folder: contains the latex sources + PDF of the final thesis. You can use the [basilea-latex template](https://github.com/ivangiangreco/basilea-latex) as a starting point.
-- **presentation** folder: contains the sources of the presentation (e.g., latex or PPT)
-- **literature** folder: contains any research paper that the student needs to read or finds interesting
-- **notes** folder: holds minutes of meetings
+- **thesis** folder: contains the latex sources + PDF of the final thesis.
+- **presentation** folder: contains the sources of the presentation.
+- **literature** used can be found in the **thesis** folder .bib or in the **presentation** folders .bib file.
+- **notes** folder: Various notes and the beginnings of a wiki.
+- `iottb` is the python testbed as a single executable (includingn python interpreter) which should be able to run on Linux machines.
 
-## Useful resources
-- [Efficient Reading of Papers in Science and Technology](https://www.cs.columbia.edu/~hgs/netbib/efficientReading.pdf)
-- [Heilmeier's catechism](https://en.wikipedia.org/wiki/George_H._Heilmeier#Heilmeier%27s_Catechism)
 
 ## Description
-Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
-
-## Visuals
-Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
-
-## Installation
-Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
+In this thesis I design a automation testbed for IoT devices.
+The main result is the software `iottb` which automates some aspects of experimenting with IoT devices.
+Currently it implements a database guided by the FAIR principles of open data as well as wraps tcpdump such that metadata is stored.
 
 ## Usage
-Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
-
+For more info see `code/iottb-project/README.md`. 
+As well as examples in the thesis writeup at `thesis/BScThesisUnibas_main-5.pdf`. <br>
+In general:
+```bash
+iottb --help # Most general overview
+iottb <subcommand> --help
+```
 ## License
-To allow further development and use during public events of the implemented system through the University of Basel, the system is expected to be well documented and provided to the university under a license that allows such reuse, e.g., the [BSD 3-clause license](https://opensource.org/license/bsd-3-clause/). The student agrees that all code produced during the project may be released open-source in the context of the PET group's projects.
+This project is licensed under the BSD 3-clause License, a copy of which is provided in the file `LICENSE` in the root of this project.
 

code/iottb-project/README.md

@@ -56,3 +56,7 @@ You can get the subcommand specif helptext by adding the `--help` option.
 
 By setting this variable you control where the basic iottb application
 configuration should be looked for
+
+## License
+This project is licensed under the BSD 3-clause License, a copy of which is provided in the file `LICENSE` in the root of this project.
+