fixing some docs.
[feisty_meow.git] / readme.txt
index 7c3496390dccb69254d620fb4e968754ee29437b..840cb801e1fec2d0c3c5539f8028b52cbc63cf0b 100644 (file)
@@ -1,11 +1,49 @@
 
 This is the "feisty meow® concerns" codebase top folder.
 
+####
+
+Feisty Meow Concerns Ltd. is a small software shop that concentrates on
+building high quality, portable, open source projects in a variety of
+languages (primarily bash, perl, python, C++, and Java).  Here are some
+highlights of our main products:
+
+  Bookmark Processing Tools - can take a mozilla bookmark file or arbitrary
+     web page and extract all the links out of it, building a csv database of
+     web links.  Using that database, a variety of output formats are
+     provided, including one that outputs a mozilla bookmark file again.
+     The most useful feature is probably the marks checker that operates on
+     our csv format and that locates all unreachable links in the file and
+     separates them out.
+
+  CROMP protocol - supports transmission of objects across the network and
+     provides a platform independent method for RPC and other types of
+     communication.
+
+  Octopus design pattern - the underpinning of the CROMP protocol.  An octopus
+     has an arbitrary number of tentacles (no, not just eight) which are each
+     responsible for consuming a different type of object (or datum).
+
+  Fast Templates and Portable Abstractions - the class libraries of Feisty Meow
+     provide numerous different data structures and programming language
+     abstractions (like threads and state machines).  There are also some
+     fairly ancient templates (in use since late 80s) which in many cases
+     perform faster than their STL analogues.
+
+  CLAM System - Feisty Meow is the home site of the CLAM makefile system.  The
+     CLAM system is a flexible and extensible method for building C++ and
+     C# files using makefiles.
+
+####
+
+Historical note:
 Feisty Meow® Concerns codebase comprises some but probably not all of several projects that
 have come before.  These include the Twain.COM library scripts, the Yeti / YetiCode library
 scripts, the HOOPLE 1 and HOOPLE 2 C++ Codebases, the Fred Huffhines open source LSL scripts,
 the CLAM build system, and a variety of other efforts.
 
+####
+
 Directories and files of interest here...
 
 scripts/
@@ -60,3 +98,23 @@ webby/
     Source code specifically for web programming and building sites.  Mainly a few javascript
     files we keep around.
 
+####
+
+Notable Prerequisites for Using the Feisty Meow® codebase:
+
+  Software required to compile under Linux:
+    Gnu C++
+    A few free source libraries (see "building.txt" for more information).
+
+  Software required to compiler under MS-windows:
+    The free Microsoft compiler should build the codebase but it is untested.
+    The full version of MS Visual Studio 2010 (version 10) is supported.
+      --but this has fallen into disrepair.
+    Gnu C++ should compile the codebase but it is also untested recently.
+
+####
+
+More information is available at the official site http://feistymeow.org
+
+####
+