lardemua/guidelines

Contains guidelines and tutorials for developing code within the lardemua organization

Guidelines for LARDEMUA

Contains guidelines and tutorials for developing code for the Laboratory of Automation and Robotics, Department of Mechanical Engineering, University of Aveiro (LARDEMUA).

Check the github page github.com/lardemua or the lars.mec.ua.pt.

Table of Contents

• Guidelines for LARDEMUA
• Table of Contents
• Installation
• Usage
• Credits
• License

Table of contents generated with markdown-toc

Installation

If this is a python standalone project, so just use the pip install and the requirements.txt file mechanism:

sudo pip install -r requirements.txt

Usage

For the sake of example, lets call this fantastic python script

script/do-nothing.py -n miguel

All the arguments are:

usage: do-nothing.py [-h] -n NAME [-v VALUE]
do-nothing.py: error: argument -n/--name is required

Credits

List the authors, current develpers, inspiring projects, etc.

Here goes an example of a table with the authors:

Author Name	Email
Vitor Santos	[email protected]
Miguel Riem Oliveira	[email protected]

License

GNU GP3. See LICENSE for full details.