diff --git a/README.md b/README.md new file mode 100644 index 0000000..658e6cd --- /dev/null +++ b/README.md @@ -0,0 +1,17 @@ +# tuberlin.ru - Russian-speaking community of TU Berlin + +Our website is designed to collect all useful information about the Technical University of Berlin in the Russian language. We build a community, help each other, and provide useful insights regarding studies and university life. + +If you want to contribute to the project, feel free to fork it, open an issue, and create a pull request. The website is currently powered by [Hugo](https://gohugo.io/) and [Congo](https://github.com/jpanther/congo/). + +To start it locally clone the repository, navigate to ```client``` folder and run: + +``` +hugo server -D +``` + +To compile run: + +``` +hugo +```