From 75616e13c0066c13b8fded5ce75935b7fb788a71 Mon Sep 17 00:00:00 2001 From: Trolli Schmittlauch Date: Thu, 8 Aug 2019 15:41:17 +0200 Subject: [PATCH] improve Readme clarity --- Readme.md | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/Readme.md b/Readme.md index 26febfb..7791f12 100644 --- a/Readme.md +++ b/Readme.md @@ -1,16 +1,23 @@ -## Requirements +# Paper: Decentralised Hashtag Search and Subscription for Federated Social Networks + +This paper has been written during my Computer Science studies at [TU Dresden](https://inf.tu-dresden.de/) as a *Großer Beleg*. +A pre-compiled PDF of the paper can be found in [paper_hashtag_federation.pdf](paper_hashtag_federation.pdf). + +## Building + +### Build Requirements All required software for this project can be installed using the [Nix package manager](https://nixos.org/nix/). The development environment is specified in `shell.nix`. The paper has been successfully build using version `19.03.173179.ef4753de2aa` of [Nixpkgs](https://nixos.org/nixpkgs/). `git-lfs` is required for retrieving all files from this repository. If installing it *after* cloning the repository, please run `git lfs install && git lfs pull`. -## Building the paper and its resources +### Building the paper and its resources The paper, expose, and all its resources can be built with `nix-shell --pure --command "make"`. If not using Nix as a package manager, please refer to the requirements specified in `shell.nix` for building with `make`. -## Running the load balancing simulation +### Running the load balancing simulation `nix-shell --pure --command "make simulation"`