Permalink
Browse files

Changed format of README to markdown and added some notes about struc…

…ture.
  • Loading branch information...
1 parent a968204 commit 8b8f2cdde747c171d7275e2e1ac8c925153800c0 @suranyami suranyami committed Apr 3, 2012
Showing with 15 additions and 5 deletions.
  1. +15 −5 README → README.md
View
@@ -1,3 +1,18 @@
+Smith2
+======
+Smith handles agents.
+Smith allows you to start an agency with multiple separate agents in separate processes.
+Agents communicate via queues using an ACL which is implemented with Protocol Buffers.
+
+Deployment
+----------
+
+* Make sure /var/cache/smith exists and is writable by the user running the agency.
+* Make sure either /etc/smith/smithrc or ~/.smithrc exists and is correct.
+
+History
+-------
+
Smith2 is a complete rewrite of Smith. Smith worked, after a fashion,
but there were lots of problems that made it hard to work with. So this
rewrite aims to fix these issues. Properly.
@@ -6,8 +21,3 @@ While Smith2 in many ways works better than Smith there are still things
that aren't implemented, not to mention all the new stuff that I want
to put in.
-Deployment
-----------
-
-* Make sure /var/cache/smith exists and is writable by the user running the agency.
-* Make sure either /etc/smith/smithrc or ~/.smithrc exists and is correct.

0 comments on commit 8b8f2cd

Please sign in to comment.