Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
doc [2014/03/07 13:02] gkazhoyadoc [2022/04/19 14:48] (current) gkazhoya
Line 1: Line 1:
 ====== CRAM documentation ====== ====== CRAM documentation ======
-~~NOTOC~~+
  
 ===== Getting started ===== ===== Getting started =====
- +  
-  * [[doc/getting_started|Getting started]]+  * [[installation|CRAM installation instructions]] 
 +  * [[/doc/ide|Setup and IDE]] describes the recommended IDE and how to set it up 
 +  * [[/doc/getting_started/lisp_crash_course|Very quick crash course in Lisp]] 
 +  * [[/tutorials|Tutorials]] to acquire hands-on experience with CRAM 
 +  * [[/doc/links|Links]] to broaden your background knowledge on Lisp, Robotics, AI, Planning 
 +  * [[/doc/guidelines|Programming Guidelines]]: skim through before starting to write your own CRAM code 
 +  * [[doc/testing|Guidelines for test-driven development]]
  
  
 ===== Frequently Asked Questions ===== ===== Frequently Asked Questions =====
  
 +  * [[https://answers.ros.org/questions/scope:all/sort:activity-desc/page:1/query:cram/|Questions on answers.ros.org]]
 +  * [[http://cram-system.org/doc/package/why_lisp|Why Lisp?]]
   * [[doc/faq| CRAM FAQ]]   * [[doc/faq| CRAM FAQ]]
-  * [[http://answers.ros.org/questions|Questions on answers.ros.org]] 
  
 +
 +===== Publications =====
 +
 +See the [[research|Research]] page.
 +
 +
 +===== Functionality Documentation =====
 +
 +  * [[doc/reasoning/overview|Geometric reasoning with bullet]]
 +  * [[doc/cpl|CRAM Plan Language (CPL) concepts]]
 +
 +
 +===== Autogenerated API =====
 +
 +  * [[doc/api/cram-language|cram-language aka CPL]]
  
  
 ===== ROS Package Documentation ===== ===== ROS Package Documentation =====
-(if we're porting the tutorials to the websiteI thought we might as well port the package documentation tooOnly someone needs to update wiki.rog.org and put some links to the website or something at some point. + 
-Also, this whole documentation is not reviewed yet and I guess we should just wait for Lorenz's thesis, which should be pretty similar but better written...) +**This section is outdatedso some code might not runSee the Tutorials page for more up to date code.** 
-  * Overview: who's who and what for+ 
 +  * [[doc/package/overview|Software and architecture overview: who's who and what for]]
   * [[doc/package/cram_language|cram_language]]   * [[doc/package/cram_language|cram_language]]
   * [[doc/package/cram_reasoning|cram_reasoning]]   * [[doc/package/cram_reasoning|cram_reasoning]]
Line 23: Line 46:
   * [[doc/package/cram_process_modules|cram_process_modules]]   * [[doc/package/cram_process_modules|cram_process_modules]]
  
-===== API ===== + 
-  * [[doc/api|Autogenerated API for all packages]] +<html><!-- 
-  * [[doc/guidelines|CRAM Programming Guidelines]]+This stuff is super outdated....
  
 ===== Logging infrastructure ===== ===== Logging infrastructure =====
Line 32: Line 55:
     * [[doc:logging:beliefstate:config_file|Configuration file]]     * [[doc:logging:beliefstate:config_file|Configuration file]]
     * [[doc:logging:communication|Communication Protocol]]     * [[doc:logging:communication|Communication Protocol]]
 +    * [[doc:logging:tutorials-cpp|Beliefstate Client Library Tutorial (C++)]]
   * [[doc/logging/roslog|ROS MongoDB logging]]   * [[doc/logging/roslog|ROS MongoDB logging]]
 +--></html>
  
-===== Physics-based Reasoning ===== 
-  * [[doc/reasoning/bullet|Overview]]