paper_hashtag_federation/Readme.md

# 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

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

`nix-shell --pure --command "make simulation"`

## License

For information about licensing, please see [Copying.md](Copying.md)
improve Readme clarity 2019-08-08 15:41:17 +02:00			`# 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`
import finished university paper & pseudonymise - dropping all history from the university paper in case it contains sensitive data 2019-08-05 23:59:43 +02:00
			`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`.

improve Readme clarity 2019-08-08 15:41:17 +02:00			`### Building the paper and its resources`
import finished university paper & pseudonymise - dropping all history from the university paper in case it contains sensitive data 2019-08-05 23:59:43 +02:00
			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`.

improve Readme clarity 2019-08-08 15:41:17 +02:00			`### Running the load balancing simulation`
import finished university paper & pseudonymise - dropping all history from the university paper in case it contains sensitive data 2019-08-05 23:59:43 +02:00
			`nix-shell --pure --command "make simulation"`

			`## License`

			`For information about licensing, please see [Copying.md](Copying.md)`