Permalink
Browse files

Create a basic tour of the source

  • Loading branch information...
1 parent 9a47101 commit c0b53471dfa1944be6fa9f8fd1145725591aea9e @richo committed Mar 27, 2013
Showing with 43 additions and 0 deletions.
  1. +43 −0 SOURCE_MAP.md
View
@@ -0,0 +1,43 @@
+Groundstation Source Map
+========================
+
+stationd
+--------
+
+stationd runs a station on the local network. By default it:
+
+- Runs a BroadcastListener which detects peers on the local
+- Runs a BroadcastAnnouncer which announces it's presence to available listeners
+- maintains a SocketPool of peers which were discovered using the Broadcast* handlers.
+
+airshipd
+--------
+
+airshipd runs the backend for the javascript frontend. By default it:
+
+- Binds a webserver on port 9005
+- Serves up everything needed to visualise and interact with your groundstation db
+
+script/cibuild
+--------------
+
+runs the tests, as well as some generic setup tasks. Intended to be run in a CI server.
+
+script/dump_gref
+----------------
+
+given a channel and a gref, dumps a `git log --graph` like structure to the terminal.
+
+Currently buggy for complex relationships.
+
+script/slurp_github
+-------------------
+
+given a valid github token in `GITHUB_TOKEN` environment variable, pulls the
+issue structure from either a single repo, (`--repo richo/groundstation`) or
+all public repos the key has push access to (`--all`)
+
+script/slurp_jira
+-----------------
+
+Similar in design to slurp github, but targeted at JIRA

0 comments on commit c0b5347

Please sign in to comment.