Skip to content
Browse files

move toward final README.

  • Loading branch information...
1 parent b8fee97 commit d81e37e2aae15017ff7c455edc04d1e1a1ce0826 @jhellerstein jhellerstein committed Apr 5, 2011
Showing with 11 additions and 26 deletions.
  1. +1 −1 LICENSE
  2. +10 −25 README
View
2 LICENSE
@@ -1,4 +1,4 @@
-Copyright (c) 2010, Regents of the University of California
+Copyright (c) 2011, Regents of the University of California
All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
View
35 README
@@ -1,46 +1,31 @@
-This is Bud, a.k.a. "Bloom Under Development". It is an initial cut at
-providing a Bloom-like language, using Ruby as a basis.
+This is Bud, a.k.a. "Bloom Under Development". It is an initial cut at a Bloom DSL, using Ruby as a setting.
+
+Please see LICENSE for licensing information.
Language cheatsheet in doc/cheat.md
This 0.0 version is not supported.
Main deficiencies at this point are:
-- Inefficient evaluation: Programs are run using (semi-)naive evaluation strategies, no
+- Inefficient evaluation: Programs are run using semi-naive evaluation strategies, but no further
query optimization has been implemented, and little effort has been spent in
tuning.
-- No Ruby constraints: Although the important Bud language features are
- available, the full power of Ruby is also available, including mutable state.
- This allows programmers to get outside the Bud framework and lose cleanliness.
+- No Ruby constraints: Within Bloom programs the full power of Ruby is also available, including mutable state.
+ This allows programmers to get outside the Bloom framework and lose cleanliness.
-- Compatibility: Bud only works with Ruby (MRI) 1.8. MRI 1.9 and other Ruby
+- Compatibility: Bud only works with Ruby (MRI) 1.8. MRI 1.9, JRuby and other Ruby
implementations are currently not supported.
To install:
- % gem build bud.gemspec
- % sudo gem install bud-0.0.1.gem
-
-To run the regression tests:
- % cd test; ruby ts_bud.rb
-
-A "one-shot" shortest paths example:
- % ruby examples/basics/paths.rb
+ % gem install bud
-A simple chat example program can be found in examples/chat. A much larger set
+Simple example programs can be found in examples. A much larger set
of example programs and libraries can be found in the bud-sandbox repo.
Optional Dependencies
=====================
The bud gem has a handful of mandatory dependencies. It also has some optional
dependencies: if you wish to use the Bud collections backed by Zookeeper (the
-"zktable" collection type), the "zookeeper" gem must be installed.
-
-Development Notes
-=================
-
-When installing an updated gem, using the "-l" option avoids querying the remote
-RubyGems repository, and hence is significantly faster:
-
- % sudo gem install -l bud-0.0.1.gem
+"zktable" collection type), the "zookeeper" gem must be installed.

0 comments on commit d81e37e

Please sign in to comment.
Something went wrong with that request. Please try again.