schmittlauch/paper_hashtag_federation
1
0
Fork 0
Code Issues 1 Pull requests Releases Wiki Activity

improve Readme clarity

Browse source
This commit is contained in:
Trolli Schmittlauch 2019-08-08 15:41:17 +02:00
parent 2c22aaede5
commit 75616e13c0
1 changed files with 10 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
Readme.md
View file

@ -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"`