Skip to content

Latest commit

 

History

History
116 lines (80 loc) · 5.21 KB

README.md

File metadata and controls

116 lines (80 loc) · 5.21 KB
Raw

Maintainability Test Coverage

Welcome to the CST Toolkit pages.

The CST Toolkit is a Java-based toolkit to allow the construction of Cognitive Architectures. It has been developed at the University of Campinas by a group of researchers in the field of Cognitive Architectures led by Prof. Ricardo Gudwin.

Note: This library is still under development, and some concepts or features might not be available yet. Feedback/bug report and Pull Requests are most welcome!

Installation

Gradle

  • Step 1. Add the JitPack repository to your build file. Add it in your root build.gradle at the end of repositories:
	repositories {
			...
			maven { url 'https://jitpack.io' }
	}
  • Step 2. Add the dependency
	dependencies {
            ...
            implementation 'com.github.CST-Group:cst-bindings:1.0.8'
	}

Sometimes, the version number (tag) in this README gets out of date, as maintainers might forget to change it when releasing. Always check the release badge to see the actual current version number that should be provided in the dependencies in Step 2 above.

Maven

  • Step 1. Add the JitPack repository to your build file.
	<repositories>
		<repository>
		    <id>jitpack.io</id>
		    <url>https://jitpack.io</url>
		</repository>
	</repositories>
  • Step 2. Add the dependency
	<dependency>
	    <groupId>com.github.CST-Group</groupId>
	    <artifactId>cst-bindings</artifactId>
	    <version>1.0.8</version>
	</dependency>

Sometimes, the version number (tag) in this README gets out of date, as maintainers might forget to change it when releasing. Always check the release badge to see the actual current version number that should be provided in the dependencies in Step 2 above.

Manual

Download the latest release and set it as a dependency in your project.

CST packages

There are four CST repos:

The original CST repo contains all core functionalities and some additional packages. It has no Swing or other graphical entities, being suitable to both desktop and mobile environments. CST-Bindings contains the needed classes to communicate with ROS and SOAR Cognitive Architecture. CST-Desktop contains some utility classes as well. It is also the complete toolkit, as it has a chain dependency with the other three repos. Finally, all classes that were once important but became obsolete as CST evolved are in CST-Legacy.

Origins of the CST Toolkit

The CST toolkit has been used successfully in a number of MS and PhD thesis in our group, either for building a cognitive architecture to be used in a particular experiment or also to foster further improvements in the own CST code due to the applications requirements.

Requirements

CST requires at minimum Java 8.

Authors and Contributors

The main contributors of this project are:

License

Copyright 2016 CST-Group

Licensed under the GNU LESSER GENERAL PUBLIC LICENSE, Version 3 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.gnu.org/licenses/lgpl-3.0.html

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.