Permalink
Browse files

Updated some documentation. Not finished yet though.

  • Loading branch information...
1 parent 19b961e commit eff58c42f23a55c289e7cde79b0215bd88421880 @dmorrill10 committed Jul 14, 2012
View
@@ -2,9 +2,6 @@
--no-private
app/**/*.rb
lib/**/*.rb
-ext/**/*.c
-
-extra_docs/AppDesign
-extra_docs/AppStatus
-extra_docs/FileStructure
-extra_docs/Glossary
+*.md
+text_docs/**/*
View
@@ -1,30 +0,0 @@
-
-
-guard 'rspec', :version => 2 do
- watch(%r{^spec/.+_spec\.rb$})
- watch(%r{^lib/(.+)\.rb$}) { |m| "spec/lib/#{m[1]}_spec.rb" }
- #watch('spec/spec_helper.rb') { "spec" }
-
- # Rails example
- #watch(%r{^spec/.+_spec\.rb$})
- #watch(%r{^app/(.+)\.rb$}) { |m| "spec/#{m[1]}_spec.rb" }
- #watch(%r{^lib/(.+)\.rb$}) { |m| "spec/lib/#{m[1]}_spec.rb" }
-
- # To watch lib/bots/proxy_bot/
- watch(%r{^(spec/)?lib/bots/proxy_bot/(.*?/*?.+?)(_spec)?\.rb$}) { |m| "spec/lib/bots/proxy_bot/#{m[2]}_spec.rb" }
-
- watch(%r{^app/controllers/(.+)_(controller)\.rb$}) { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
- #watch(%r{^spec/support/(.+)\.rb$}) { "spec" }
- #watch('spec/spec_helper.rb') { "spec" }
- #watch('config/routes.rb') { "spec/routing" }
- #watch('app/controllers/application_controller.rb') { "spec/controllers" }
- # Capybara request specs
- #watch(%r{^app/views/(.+)/.*\.(erb|haml)$}) { |m| "spec/requests/#{m[1]}_spec.rb" }
-end
-
-
-guard 'bundler' do
- watch('Gemfile')
- # Uncomment next line if Gemfile contain `gemspec' command
- # watch(/^.+\.gemspec/)
-end
View
@@ -0,0 +1,17 @@
+License
+=========
+
+Copyright © 2012 by the Computer Poker Research Group, University of Alberta.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicence, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+Except as contained in this notice, the name(s) of the above copyright holders shall not be used in advertising or otherwise to promote the sale, use or other dealings in this Software without prior written authorization.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+Credits
+-------
+
+Dustin Morrill: morrill@ualberta.ca
View
@@ -1,108 +0,0 @@
-= Glossary of Terms
-
-[<em>ACPC dealer</em>]
- The program used to deal cards and manage poker
- _matches_. It is the official program used by the Annual Computer
- Poker Competition to run its matches and was developed by the _CPRG_.
-
-[_action_]
- A method in a _controller_, to which a _route_ is mapped.
-
-[_Apache_]
- A commonly used production-grade web server that is also used by
- this application.
-
-[<em>background server</em>]
- A server to run jobs in background. Background jobs are necessary because a
- TCP socket needs to be persisted in order to communicate with the
- <em>ACPC Dealer</em>.
-
-[<em>Beanstalkd server</em>]
- The background server implementation currently being used to run jobs in
- the background.
-
-[_bot_]
- An automated agent that can play matches against other _competitors_ without
- input from a user.
-
-[<em>Client response</em>]
- A matchstate string with an appended action:
- <some matchState>:{ <limitAction> or <noLimitAction> }
-
-[_competitor_]
- A _user_ or _bot_. A competitor can participate in a match.
-
-[_controller_]
- A class that inherits from +ApplicationController+, contains
- _actions_ that render _views_ to the browser, and delegates business logic to
- _models_.
-
-[_CPRG_]
- The University of Alberta's Computer Poker Research Group.
-
-[_gem_]
- A plug-in-like Ruby library or application that adds
- functionality to another Ruby application. Gems are listed in +Gemfile+ and
- are installed by running +bundle install+ from within the application
- directory hierarchy.
-
-[_host_]
- A _competitor_ who starts a match by running an instance of the
- <em>ACPC Dealer</em>.
-
-[<em>Javascript template</em>]
- Javascript embedded in an +ERB+ or +HAML+
- format template. It usually has an +.js.erb+ or +.js.haml+ extension.
-
-[_match_]
- A sequence of poker hands managed by the <em>ACPC dealer</em> and played by
- _competitors_.
-
-[<em>match state</em>]
- The state of a _match_. A match state completely describes the match at a
- particular time.
-
-[<em>matchstate string</em>]
- A string from the dealer of the form:
- MATCHSTATE:<position>:<handNumber>:<betting>:<cards>
-
-[_model_]
- A class that works with data from, and provides results to,
- _controllers_.
-
-[<em>partial template</em> or _partial_]
- A snippet of template code
- (+ERB+, +HAML+, etc.)
- that can be inserted into full templates at run time. By convention, partial
- template files begin with an underscore ('_').
-
-[_participant_]
- A _competitor_ who joins a _table_.
-
-[<em>Phusion Passenger</em>]
- Gem that integrates this rails application
- with _Apache_.
-
-[_route_]
- A map between URL parameters and _controller_ _actions_.
-
-[_table_]
- The arena upon which _matches_ are held. _Competitors_ participate in matches
- by joining or hosting a table.
-
-[_template_]
- A file that can be interpreted into an +HTML+ page, which can
- be displayed in a browser. It is usually written in +ERB+ or +HAML+ and is a
- file with a +.html.erb+ or +.html.haml+ extension respectively.
-
-[_user_]
- A browser operator. A user can play matches against other _competitors_.
-
-[_view_]
- A set of _templates_ that can be rendered by _controller_ _actions_
- to the browser.
-
-[_worker_]
- A class that inherits from +BackgrounDRb::MetaWorker+
- and is run as on the <em>BackgrounDRb server</em>. Worker class files are
- stored in +lib/workers/+.
View
@@ -1,31 +0,0 @@
-License
-=========
-
-Copyright (C) 2012 by the Computer Poker Research Group, University of Alberta
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of
-this software and associated documentation files (the "Software"), to deal in
-the Software without restriction, including without limitation the rights to
-use, copy, modify, merge, publish, distribute, sublicence, and/or sell copies
-of the Software, and to permit persons to whom the Software is furnished to do
-so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-Except as contained in this notice, the name(s) of the above copyright holders
-shall not be used in advertising or otherwise to promote the sale, use or other
-dealings in this Software without prior written authorization.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
-
-Credits
--------
-
-Dustin Morrill: morrill@ualberta.ca
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
View
@@ -0,0 +1,68 @@
+= Glossary of Terms
+
+[<em>{ACPC Dealer}[http://www.computerpokercompetition.org/index.php?option=com_rokdownloads&view=folder&Itemid=59]</em>]
+ The program used to deal cards and manage poker _matches_. It is the official program used by the Annual Computer Poker Competition to run its matches.
+
+[_action_]
+ A method in a _controller_[http://guides.rubyonrails.org/action_controller_overview.html], to which a _route_ is mapped.
+
+[_Apache_[http://www.apache.org/]]
+ A commonly used production-grade web server that is also used by this application.
+
+[<em>background process server</em>]
+ A server to run jobs in background. Background processes are necessary because a TCP socket needs to be persisted in order to communicate with the <em>{ACPC Dealer}[http://www.computerpokercompetition.org/index.php?option=com_rokdownloads&view=folder&Itemid=59]</em>.
+
+[_Beanstalkd_[http://kr.github.com/beanstalkd/]]
+ The <em>background process server</em> implementation currently being used to run jobs in the background.
+
+[_bot_]
+ An automated agent that can play matches against other _competitors_ without input from a human user.
+
+[<em>Player response</em>]
+ A matchstate string with an appended action, according to the format specified by the <em>{ACPC Dealer}[http://www.computerpokercompetition.org/index.php?option=com_rokdownloads&view=folder&Itemid=59]</em>.
+
+[_competitor_]
+ A user operating a browser or a _bot_. A competitor can participate in a _match_.
+
+[_controller_[http://guides.rubyonrails.org/action_controller_overview.html]]
+ A class that inherits from +ApplicationController+, contains _actions_ that render _views_ to the browser, and delegates business logic to _models_ and background processes.
+
+[_CPRG_[http://poker.cs.ualberta.ca/]]
+ The University of Alberta's Computer Poker Research Group.
+
+[_gem_[http://docs.rubygems.org/read/chapter/1/]]
+ A plug-in-like Ruby library or application that adds functionality to another Ruby application. Gems are listed in +Gemfile+ and are installed by running +bundle install+ from the application's root directory.
+
+[<em>Javascript template</em>]
+ Javascript embedded in an +ERB+ or +HAML+ format template. It usually has an +.js.erb+ or +.js.haml+ extension.
+
+[_match_]
+ A sequence of poker hands managed by the <em>{ACPC Dealer}[http://www.computerpokercompetition.org/index.php?option=com_rokdownloads&view=folder&Itemid=59]</em> and played by _competitors_.
+
+[<em>match state</em>]
+ The state of a _match_ on a certain turn during a particular hand. Strings describing the match state are sent to _participants_ by the <em>{ACPC Dealer}[http://www.computerpokercompetition.org/index.php?option=com_rokdownloads&view=folder&Itemid=59]</em>.
+
+[_model_[]]
+ A class that works with data from, and provides results to,
+ _controllers_.
+
+[<em>partial template</em> or _partial_]
+ A snippet of template code (+ERB+, +HAML+, etc.) that can be inserted into full templates at run time. By convention, partial template files begin with an underscore ('_'). See <em>{Layouts and Rendering in Rails}[http://guides.rubyonrails.org/layouts_and_rendering.html]</em> for more information.
+
+[_participant_]
+ A _competitor_ who joins a <em>{ACPC Dealer}[http://www.computerpokercompetition.org/index.php?option=com_rokdownloads&view=folder&Itemid=59]</em> hosting a _match_.
+
+[<em>Phusion Passenger</em>]
+ Integration manager between _Rails_[http://rubyonrails.org/] and _Apache_[http://www.apache.org/].
+
+[_route_[http://guides.rubyonrails.org/routing.html]]
+ A map between URL parameters and _controller_[http://guides.rubyonrails.org/action_controller_overview.html] _actions_.
+
+[_template_]
+ A file that can be interpreted into an +HTML+ page, which can be displayed in a browser. It is usually written in +ERB+ or +HAML+ and is a file with a +.html.erb+ or +.html.haml+ extension respectively. See <em>{Layouts and Rendering in Rails}[http://guides.rubyonrails.org/layouts_and_rendering.html]</em> for more information.
+
+[_view_]
+ A set of _templates_ that can be rendered by _controller_[http://guides.rubyonrails.org/action_controller_overview.html] _actions_ to the browser. See <em>{Layouts and Rendering in Rails}[http://guides.rubyonrails.org/layouts_and_rendering.html]</em> for more information.
+
+[_worker_]
+ A process running on a <em>background process server</em>. The worker script for this application (+lib/background/worker.rb+) is based on the +Stalker+ gem and runs on _Beanstalkd_[http://kr.github.com/beanstalkd/].

0 comments on commit eff58c4

Please sign in to comment.