Skip to content

Commit 8b6aabc

Browse files
samarseneaultsamarseneault
authored
Initial Documentation Revision (buzz-lang#96)
* Documention for variables, control statements, matrix and queue libraries * Doc for swarm management, comments, file inclusion * Documentation for stigmergy and swarm management * Fixed documentation indentation * Documentation for Buzz integration * Added missing commas in class definition * Corrected file API * Argos integration + table of contents * Added Buzz concepts and pictures * Fix markdown typo * Added pattern formation + distance gradient examples * Added toolset documentation * Added syntax and assembler specifications * Added Buzz news and Who Made Buzz * Added KheperaIV integration * Added demo link * Converted integration.org to markdown * Converted api.org to markdown * Added boolean and comparison operators * Usage examples * Header formatting * Added string examples and missing includes * Indentation formatting in examples * Fix class method binding * Add REST-Like API example
1 parent 53da15b commit 8b6aabc

29 files changed

+3077
-683
lines changed

‎README.md

Lines changed: 65 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
What is Buzz?
2-
=============
1+
# What is Buzz?
32

43
Buzz is a novel programming language for heterogeneous robots swarms.
54

@@ -13,48 +12,67 @@ Self-organization results from the fact that the Buzz run-time platform is purel
1312

1413
The language can be extended to add new primitives (thus supporting heterogeneous robot swarms) and can be laid on top of other frameworks, such as ROS.
1514

16-
More information is available at http://the.swarming.buzz/wiki/doku.php?id=start.
17-
18-
Downloading Buzz
19-
================
20-
21-
You can download the development sources through git:
22-
23-
$ git clone https://github.com/MISTLab/Buzz.git buzz
24-
25-
Compiling Buzz
26-
==============
27-
28-
Requirements
29-
------------
30-
31-
You need the following packages:
32-
33-
* A UNIX system (Linux or MacOSX; Microsoft Windows is not supported)
34-
* _g++_ >= 4.3 (on Linux) or _clang_ >= 3.1 (on MacOSX)
35-
* _cmake_ >= 2.8.12
36-
37-
Optionally, you can also install [ARGoS](http://www.argos-sim.info/).
38-
39-
Compilation
40-
-----------
41-
42-
To compile Buzz, execute the following:
43-
44-
$ cd buzz
45-
$ mkdir build
46-
$ cd build
47-
$ cmake ../src
48-
$ make
49-
50-
Installation
51-
============
52-
53-
Execute these commands:
54-
55-
$ cd buzz/build
56-
$ sudo make install
57-
58-
On Linux, run this command too:
59-
60-
$ sudo ldconfig
15+
A simulation demonstration is available [here](https://www.youtube.com/watch?v=WAlS7a7_BaM)
16+
17+
The whitepaper on Buzz Design and Implementation is available [here](https://arxiv.org/abs/1507.05946).
18+
19+
20+
# Documentation Contents
21+
The documentation is structured as follows:
22+
1. [Installation](doc/installation.md)
23+
2. [ARGoS Integration](doc/argos-integration.md)
24+
3. Buzz Concepts\
25+
3.1 [Basics](doc/concepts/basics.md)\
26+
3.2 [Virtual Machine](doc/concepts/vm.md)
27+
4. [Buzz API](doc/api.md)
28+
5. [Extending Buzz](doc/integration.md)
29+
6. Examples\
30+
6.1 [Distance Gradient](doc/examples/distance_gradient.md)\
31+
6.2 [Pattern Formation](doc/examples/pattern_formation.md)\
32+
6.3 [REST-Like API](doc/examples/rest_api.md)
33+
7. Technical Specifications\
34+
7.1 [Assembly Language](doc/technical-specifications/assembler.md)\
35+
7.2 [Backus-Naur Form Syntax](doc/technical-specifications/syntax.md)
36+
8. Robot Integration\
37+
8.1 [Khepera IV](robot-integration/kheperaiv.md)
38+
39+
# Who Made Buzz?
40+
Buzz is a research project conducted at [NESTLab](https://www.nestlab.net), [Worcester Polytechnic Institute](https://www.wpi.edu), and [MIST](https://www.mistlab.ca), [École Polytechnique de Montréal](https://www.polymtl.ca). It is funded by the [Natural Sciences and Engineering Research Council of Canada](https://www.nserc-crsng.gc.ca).
41+
42+
The main developer and maintainer is [Carlo Pinciroli](https://carlo.pinciroli.net).
43+
44+
# Buzz News
45+
46+
## Scientific Publications
47+
48+
* C. Pinciroli, G. Beltrame. 2016. **Swarm-Oriented Programming of Distributed Robot Networks**. *IEEE Computer*. In press.
49+
* C. Pinciroli, G. Beltrame. 2016. **Buzz: An Extensible Programming Language for Heterogeneous Swarm Robotics**. *Proceedings of the IEEE/RSJ International Conference on Intelligent Robots and Systems (IROS 2016)*. In press.
50+
* C. Pinciroli and G. Beltrame. 2016. **Buzz: A Programming Language for Robot Swarms**. *IEEE Software, volume 33, number 4, pages 97-100*. IEEE Press.
51+
* C. Pinciroli, A. Lee-Brown, G. Beltrame. 2015. **A Tuple Space for Data Sharing in Robot Swarms**. *9th EAI International Conference on Bio-inspired Information and Communications Technologies (BICT 2015), pages 287-294*. ACM Digital Library.
52+
53+
## Media Coverage
54+
55+
* [2015/08/11] Heise: [short version](http://www.heise.de/newsticker/meldung/Roboterschwaerme-bekommen-eigene-Programmiersprache-2775563.html) [full version](http://www.heise.de/tr/artikel/Programmiersprache-fuer-Roboterschwaerme-2775561.html)
56+
* [2015/08/10] [RoboHub](http://robohub.org/buzz-a-novel-programming-language-for-heterogeneous-robot-swarms/)
57+
* [2015/08/06] [École Polytechnique de Montréal](http://www.polymtl.ca/carrefour/article.php?no=4692)
58+
* [2015/08/03] [Communications of the ACM](http://cacm.acm.org/news/190313-a-programming-language-for-robot-swarms/fulltext)
59+
* [2015/08/03] [Fusion](http://fusion.net/story/175797/robot-swarms-just-got-a-little-scarier/)
60+
* [2015/07/30] [SD Times](http://sdtimes.com/researchers-develop-buzz-a-programming-language-for-robot-swarms/)
61+
* [2015/07/29] [MIT Technology Review](http://www.technologyreview.com/view/539761/a-programming-language-for-robot-swarms/)
62+
63+
## Talks, Tutorials, Demos
64+
65+
* [2017/01/04] The [ICRA2017 tutorial page](http://the.swarming.buzz/ICRA2017/) is online!
66+
* [2016/11/16] Tutorial proposal on Buzz accepted at [ICRA2017](http://www.icra2017.org/).
67+
* [2016/10/29-30] Demo at [NERC 2016](http://northeastrobotics.org/NERC2016.html), the 5th Northeast Robotics Colloquium.
68+
* [2016/10/12] Oral presentation at [IROS 2016](http://www.iros2016.org/)
69+
* [2016/06/18] Tutorial at the [Swarmathon workshop](http://nasaswarmathon.com/rssworkshop) at [RSS2016](http://www.roboticsconference.org)
70+
* [2016/01/29] Colloquium at [Worcester Polytechnic Institute](https://www.wpi.edu): *Software for Complex Robot Swarms* (Carlo Pinciroli)
71+
* [2016/01/15] Colloquium at [Université de Montreal](https://www.umontreal.ca): *Software for Complex Robot Swarms* (Carlo Pinciroli)
72+
* [2015/11/19] Guest lecture for the course of [Evolutionary Swarm Robotics](https://sites.google.com/site/esrcs591/) ([Prof. Moses](https://www.cs.unm.edu/~melaniem/Home.html)) at [University of New Mexico](http://www.unm.edu): *Programming Complex Robot Swarms* (Carlo Pinciroli)
73+
* [2015/11/18] Colloquium at [University of New Mexico](http://www.unm.edu): *Software for Complex Swarm Robotics* (Carlo Pinciroli)
74+
75+
## Other
76+
77+
* [2016/03/02] Buzz to be used in the [NASA Swarmathon](http://nasaswarmathon.com/)
78+
* [2015/08/10] [The Hello World Collection](http://helloworldcollection.de/) includes an example for a Buzz 'Hello world!' program.

0 commit comments

Comments
 (0)