From a75a11ded41c814f0ba9b12a5742c0c58405224a Mon Sep 17 00:00:00 2001 From: Lionel Sambuc Date: Thu, 14 Mar 2019 14:37:54 +0100 Subject: [PATCH] Removed difference with examples --- LICENSE | 3 +- README.md | 76 ++++++++++++++++++++++++++++++++++++++++++++++-- docs/_config.yml | 2 +- 3 files changed, 77 insertions(+), 4 deletions(-) diff --git a/LICENSE b/LICENSE index 777384a..7306aa9 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,7 @@ The MIT License (MIT) -Copyright (c) 2019 Lionel Sambuc +Copyright (c) 2019 Data Intensive Applications and Systems Laboratory (DIAS) + Ecole Polytechnique Federale de Lausanne Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index 68721ed..2a4564a 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,74 @@ -# test-docs -Testing GitHub Pages system +# PROJECT_NAME + +## Introduction + +This is a template for projects, containing a default license, as well as +examples for the documentation. + +In order to use these templates, please: + 1. Update the year in the license file + 2. Adapt this README file + 3. Adapt `docs/_config` so that the links points to the correct URLs, + also update the project name and short description. + 4. As needed, write documentation, using the templates in `docs` + +## Requirements + +### Hardware + + * **Processor:** 1GHz CPU + * **RAM:** 1 MB + * **Available storage space:** 1 MB + +### Software + + * Ubuntu + * LLVM + +## Quick start + +## Building from sources + +To build this project, you will need to run the following: + +```sh +make +``` + +### Installation + +To install the software on the system you can use: + +```sh +make install +``` + +### Usage + +Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin vehicula pretium +quam sit amet facilisis. Class aptent taciti sociosqu ad litora torquent per +conubia nostra, per inceptos himenaeos. Curabitur metus sapien, rhoncus vitae +eleifend nec, convallis vel nunc. Nulla metus mauris, porta eu porta eu, +vulputate et est. Suspendisse lacinia leo vel auctor aliquet. Maecenas non arcu +libero. Nulla ut eleifend dui. Cras bibendum pharetra facilisis. Proin mattis +libero non pharetra tristique. Nam massa nulla, ultrices pharetra quam a, +fermentum placerat dolor. Nullam mollis libero et neque lobortis, id dignissim +lectus dignissim. Maecenas ligula enim, congue in ornare vel, volutpat ut ante. + +```sh + +``` + +Quisque id velit erat. Quisque gravida posuere nisi, quis vestibulum urna +egestas in. Curabitur accumsan eget elit quis molestie. Nunc vestibulum, dolor +nec interdum iaculis, enim mauris auctor ligula, ac suscipit velit ex eu lectus. + +## Documentation + +For more information, please refer to the [documentation](https://epfl-dias.github.io/PROJECT_NAME). + +## Acknowledgements + +Quisque id velit erat. Quisque gravida posuere nisi, quis vestibulum urna +egestas in. Curabitur accumsan eget elit quis molestie. Nunc vestibulum, dolor +nec interdum iaculis, enim mauris auctor ligula, ac suscipit velit ex eu lectus. diff --git a/docs/_config.yml b/docs/_config.yml index 03dac68..3b5626f 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -11,6 +11,6 @@ aux_links: "Twitter": - "https://twitter.com/dias_EPFL" "GitHub": - - "https://github.com/epfl-dias/project" + - "https://github.com/epfl-dias/PROJECT_NAME" remote_theme: pmarsceill/just-the-docs