Commits

Ivan Andrus committed 26071af

Added documentation headers

Comments (0)

Files changed (2)

+;;; achievements.el --- achievements for emacs usage
 
-;; TODO: Documentation
-;; TODO: Make it persistent by saving to a file
+;; Author: Ivan Andrus <darthandrus@gmail.com>
+;; Maintainer: Ivan Andrus <darthandrus@gmail.com>
+;; Created: 2012-10-07
+;; Keywords: games
+
+;;; Install:
+
+;; A simple (require 'achievements).  However, currently it is also
+;; highly recommended to install the command-frequency package in
+;; order to get all the functionality.
+
+;;; Commentary:
+
+;; Running `achievements-list-achievements' will show a list of all
+;; unlocked achievements.
+
+;;; Code:
+
 ;; TODO: Make an `unlocks' attribute so that using org-mode will (require 'org-achievements)
 ;; TODO: easy way to show a random unearned achievement, perhaps on an idle timer
 
 (require 'basic-achievements)
 
 (provide 'achievements)
+
+;;; achievements.el ends here

basic-achievements.el

+;;; basic-achievements.el --- Some basic achievements
+
+;; Author: Ivan Andrus <darthandrus@gmail.com>
+;; Maintainer: Ivan Andrus <darthandrus@gmail.com>
+;; Created: 2012-10-07
+;; Keywords: games
+
+;;; Commentary:
+
+;; This is the main entry point for achievement defintions.  Other
+;; files can be included from here using the `:unlocks' slot.
+
+;;; Code:
+
 ;;{{{ meta
 
 (defachievement "Achiever"
   :min-score 100)
 
 ;;}}}
-;;{{{ uptimes
+;;{{{ Uptimes
 
 (defachievement "Pretty Stable"
   "You have an uptime of over 1 day."
 ;;}}}
 
 (provide 'basic-achievements)
+
+;;; basic-achievements.el ends here
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.