summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorTodd Gamblin <tgamblin@llnl.gov>2014-01-13 05:10:08 +0100
committerTodd Gamblin <tgamblin@llnl.gov>2014-01-13 05:10:08 +0100
commitd6ce48aa6ba5627ced19c278191a28426f6cc099 (patch)
treead64cd47fd0ef16a76bf177c662adf6d9a4b3b87 /README.md
parent3a152ed9231cf75904f3c27909c6df9a000a9218 (diff)
downloadspack-d6ce48aa6ba5627ced19c278191a28426f6cc099.tar.gz
spack-d6ce48aa6ba5627ced19c278191a28426f6cc099.tar.bz2
spack-d6ce48aa6ba5627ced19c278191a28426f6cc099.tar.xz
spack-d6ce48aa6ba5627ced19c278191a28426f6cc099.zip
Add README for github repo.
Diffstat (limited to 'README.md')
-rw-r--r--README.md37
1 files changed, 37 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000000..ad531a44d0
--- /dev/null
+++ b/README.md
@@ -0,0 +1,37 @@
+Spack
+===========
+
+Spack is a package management tool designed to support multiple
+versions and configurations of software on a wide variety of platforms
+and environments. It was designed for large supercomputing centers,
+where many users and application teams share common installations of
+software on clusters with exotic architectures, using libraries that
+do not have a standard ABI. Spack is non-destructive: installing a new
+version does not break existing installations, so many configurations
+can coexist on the same system.
+
+Most importantly, Spack is simple. It offers a simple spec syntax so
+that users can specify versions and configuration options
+concisely. Spack is also simple for package authors: package files are
+writtin in pure Python, and specs allow package authors to write a
+single build script for many different builds of the same package.
+
+See the
+[Feature Overview](http://scalability-llnl.github.io/spack/features.html)
+for examples and highlights.
+
+To install spack and install your first package:
+
+ $ git clone git@github.com:scalability-llnl/spack.git
+ $ cd spack/bin
+ $ ./spack install libelf
+
+Documentation
+----------------
+
+[Full documentation](http://scalability-llnl.github.io/spack)
+for Spack is also available.
+
+Authors
+----------------
+Spack was written by Todd Gamblin, tgamblin@llnl.gov.