sample

sample / StandardAlgorithmDescription / 0.1.0

README.md

Table of Contents

  1. Introdution
  2. Detailed Explanation of How Your Algorithm Works
  3. Examples
  4. Credits

Introduction

This is where you give an introductionary explanation of what your algorithm does, link it's wikipeda article (if applicable) and highlight interesting things about what it can do.

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Fusce at tellus eget nulla gravida facilisis ac in neque. Sed auctor, magna eu euismod ornare, turpis libero viverra diam, eget ullamcorper est arcu ut leo. Mauris efficitur felis quis dolor laoreet convallis. Vivamus eget tempor nisi. Phasellus ultricies, orci vitae volutpat ullamcorper, mi neque malesuada lorem, sit amet congue urna odio sit amet erat. Pellentesque varius scelerisque elit, a porta eros sodales quis. Praesent ultricies, odio vitae pretium auctor, sem lacus suscipit odio, ac rhoncus lectus tortor vitae risus. Phasellus tempor ipsum eros, a varius ligula porttitor a. Nunc tincidunt felis ac augue venenatis efficitur. Integer nec augue rutrum, interdum ipsum vitae, vestibulum ex. Proin venenatis condimentum turpis, vel molestie mauris ornare ut. Vestibulum eget egestas massa.

Input:

  • (Required) First input description goes here. *
  • (Optional) Second input description goes here. **

* 1st input note goes here
** 2nd input note goes here

Output:

  • First output description goes here.
  • Second output description goes here. *
  • Third output description goes here. **

* 1st output note goes here
** 2nd output note goes here


Detailed Explanation of How Your Algorithm Works

Nam ut diam nunc. Fusce at nisi at quam venenatis feugiat ut quis lacus. Quisque eget efficitur orci. Mauris interdum blandit arcu, sit amet posuere lorem volutpat convallis. Vestibulum eu odio lacus. Aenean condimentum purus id odio feugiat, nec mattis est accumsan. Vivamus elementum pharetra felis, ut bibendum purus faucibus quis. Praesent dolor turpis, mollis et pellentesque cursus, pulvinar a dolor. Quisque pharetra arcu ut urna dictum, nec venenatis lacus mattis. Ut id tincidunt erat.

a. Detailed Explanation Step 1

Duis odio elit, mollis vitae ante quis, efficitur varius augue. Praesent luctus, sem sit amet elementum viverra, erat quam scelerisque arcu, at aliquam tortor felis in erat. Nulla bibendum sem ac dolor laoreet, sit amet venenatis erat suscipit. Donec ultrices vehicula efficitur.

{
    "Example Key":"Example Value",
    "Example Key 2":"Example Value 2"
}

Praesent metus velit, pulvinar et mi nec, elementum lacinia felis. Morbi et efficitur turpis, sed tincidunt ante. Quisque venenatis gravida sapien quis ornare. Vivamus maximus felis sed sapien commodo euismod. Etiam vitae augue vestibulum risus varius tristique in a nunc.

b. Detailed Explanation Step 2

Suspendisse vitae diam ipsum. Nam sit amet arcu et lacus ullamcorper iaculis non id ante. Cras suscipit ornare massa, eu varius arcu tincidunt id. Duis tincidunt, metus sed euismod hendrerit, nunc nisl luctus dui, id efficitur mauris lacus id elit. Suspendisse potenti. Sed eget luctus ligula, et scelerisque justo. Fusce nec aliquam lorem. Aliquam id tortor ac augue accumsan lobortis ac nec diam. Aenean venenatis tellus eu gravida pharetra. Vestibulum dui tortor, convallis quis cursus et, finibus et elit. Cras blandit, magna nec ultricies ornare, odio risus suscipit erat, id luctus odio velit sit amet dolor. Praesent dui nisl, rhoncus sed nunc sit amet, elementum varius leo.


Examples

Example 1.

  • Parameter 1: Details of 1st parameter
{
    "parameter1": "value1"
}

Output

{
    "outputkey1": "outputvalue1",
    "outputkey2": "outputvalue2",
    "outputkey3": "outputvalue3"
}

Example 2.

  • Parameter 1: Details of 1st parameter
  • Parameter 2: Details of 2nd parameter
{
    "parameter1": "value1",
    "parameter2": "value2"
}

Output

{
    "outputkey1": "outputvalue1",
    "outputkey2": "outputvalue2",
    "outputkey3": "outputvalue3"
}

Credits

All credits go here if applicable. This could be a biblatex reference, academic paper url, github repository url or anything else similar.