GAMS  1.2.2
README.md
Go to the documentation of this file.
1 [![Build Status](https://travis-ci.org/jredmondson/gams.svg?branch=master)](https://travis-ci.org/jredmondson/gams) [![Documentation Status](https://readthedocs.org/projects/gams/badge/?version=latest)](https://gams.readthedocs.io/en/latest/?badge=latest) [![Javadocs](https://www.javadoc.io/badge/ai.gams/gams.svg)](https://www.javadoc.io/doc/ai.gams/gams)
2 
3 # About GAMS
4 
5 The Group Autonomy for Mobile Systems (GAMS) project at Carnegie Mellon University
6 is intended to provide a distributed operating environment for control of one or
7 more unmanned autonomous systems (UAS). The repository is composed of C++, Java,
8 MADARA, and some LUA bindings that enable a single person to control and understand
9 information from a swarm of agents, robots, or UAS.
10 
11 GAMS is an extension of an earlier project called SMASH.
12 
13 ***
14 
15 # Installation
16 
17 See the instructions at https://github.com/jredmondson/gams/wiki/GAMS-Installation
18 for a list of methods for installing GAMS and its prerequisites. For Linux users,
19 we have scripts in $GAMS_ROOT/scripts/linux that are useful for not only building
20 but also getting the latest version of repositories. See the base_build.sh script
21 in the linux directory for more information (pass help to it).
22 
23 For Windows users, you will need to download the repositories for ACE, MADARA and
24 GAMS along with whatever options you are wanting to compile in. Then, you can use
25 the helpful base_build.bat script in %GAMS_ROOT%\scripts\windows to build GAMS
26 and prerequisites. Pass help from command line to see options.
27 
28 For the base_build scripts on Linux or Windows, you will need to at LEAST pass
29 in "madara gams" in on a first build. After that, you can pick
30 and choose what you want to update. Tests, vrep, and other options will need
31 to be added by most users. There is a build_c++ script that wraps common options
32 for most users.
33 
34 ***
35 
36 # Generating GAMS projects
37 
38 We have a script called gpc.pl in $GAMS_ROOT/scripts/projects that is very useful
39 for generating almost any kind of GAMS or MADARA project. See -h for usage
40 information. The most common GAMS Project Configurator (GPC) usage is the
41 --new-algorithm option and the many options for configuring a VREP simulation.
42 Again, see the help information for specifics.
43 
44 ***
45 
46 # Compiling GAMS projects
47 
48 After you've generated a project with the GPC, you should see two scripts in
49 your project directory (action.bat|sh). The .bat file is used by Visual Studio
50 users to compile GAMS projects. The .sh file is used by Linux g++ users to
51 compile GAMS projects. Pass "help" to the script for usage information.
52 
53 ***
54 
55 # Help
56 
57  1. Please see our helpful Wiki which include guides at:
58  https://github.com/jredmondson/gams/wiki
59 
60  2. Please see our full c++ doxygen documentation at:
61  http://gams.readthedocs.io
62 
63  Java docs are available here:
64  https://www.javadoc.io/doc/ai.gams/gams
65 
66  3. Issues can be posted to our Issue system (which hasn't gotten any usage):
67  https://github.com/jredmondson/gams/issues
68 
69  4. If you are still having trouble, feel free to contact me directly at:
70  jedmondson@gmail.com