summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTodd Gamblin <tgamblin@llnl.gov>2019-06-30 23:01:57 -0700
committerTodd Gamblin <tgamblin@llnl.gov>2019-06-30 23:08:33 -0700
commitaf3939057882f6c5c19e10f4c0ddc7dbde787154 (patch)
treed1bbf75e980bcd5a653cf1b05610390c0a130c62
parent9c37a4c948eff6032cb68e35de118a1469de5901 (diff)
downloadspack-af3939057882f6c5c19e10f4c0ddc7dbde787154.tar.gz
spack-af3939057882f6c5c19e10f4c0ddc7dbde787154.tar.bz2
spack-af3939057882f6c5c19e10f4c0ddc7dbde787154.tar.xz
spack-af3939057882f6c5c19e10f4c0ddc7dbde787154.zip
README: Tighten up text, mention the Code of Conduct in the README.
-rw-r--r--README.md67
1 files changed, 32 insertions, 35 deletions
diff --git a/README.md b/README.md
index a2c86da5b7..6139404ae4 100644
--- a/README.md
+++ b/README.md
@@ -26,55 +26,45 @@ Then:
$ git clone https://github.com/spack/spack.git
$ cd spack/bin
- $ ./spack install libelf
+ $ ./spack install zlib
Documentation
----------------
-[**Full documentation**](http://spack.readthedocs.io/) for Spack is
-the first place to look.
+[**Full documentation**](http://spack.readthedocs.io/) is available, or
+run `spack help` or `spack help --all`.
-Try the
-[**Spack Tutorial**](http://spack.readthedocs.io/en/latest/tutorial.html),
-to learn how to use spack, write packages, or deploy packages for users
-at your site.
+Tutorial
+----------------
+
+We maintain a
+[**hands-on tutorial**](http://spack.readthedocs.io/en/latest/tutorial.html).
+It covers basic to advanced usage, packaging, developer features, and large HPC
+deployments. You can do all of the exercises on your own laptop using a
+Docker container.
-See also:
- * [Technical paper](http://www.computer.org/csdl/proceedings/sc/2015/3723/00/2807623.pdf) and
- [slides](https://tgamblin.github.io/files/Gamblin-Spack-SC15-Talk.pdf) on Spack's design and implementation.
- * [Short presentation](https://tgamblin.github.io/files/Gamblin-Spack-Lightning-Talk-BOF-SC15.pdf) from the *Getting Scientific Software Installed* BOF session at Supercomputing 2015.
+Feel free to use these materials to teach users at your organization
+about Spack.
-Get Involved!
+Community
------------------------
Spack is an open source project. Questions, discussion, and
contributions are welcome. Contributions can be anything from new
-packages to bugfixes, or even new core features.
-
-### Mailing list
-
-If you are interested in contributing to spack, join the mailing list.
-We're using Google Groups for this:
-
- * [Spack Google Group](https://groups.google.com/d/forum/spack)
-
-### Slack channel
-
-Spack has a Slack channel where you can chat about all things Spack:
+packages to bugfixes, documentation, or even new core features.
- * [Spack on Slack](https://spackpm.slack.com)
+**Resources:**
-[Sign up here](https://spackpm.herokuapp.com) to get an invitation mailed
-to you.
-
-### Twitter
-
-You can follow [@spackpm](https://twitter.com/spackpm) on Twitter for
-updates. Also, feel free to `@mention` us in in questions or comments
-about your own experience with Spack.
-
-### Contributions
+* **Slack workspace**: [spackpm.slack.com](https://spackpm.slack.com).
+ Open to anyone; visit
+ [spackpm.herokuapp.com](https://spackpm.herokuapp.com) to have an
+ invitation emailed to you automatically.
+* **Mailing list**: https://groups.google.com/d/forum/spack
+* **Twitter**: [@spackpm](https://twitter.com/spackpm). Be sure to
+ `@mention` us!
+Contributing
+------------------------
Contributing to Spack is relatively easy. Just send us a
[pull request](https://help.github.com/articles/using-pull-requests/).
When you send your request, make ``develop`` the destination branch on the
@@ -92,6 +82,13 @@ branching model. The ``develop`` branch contains the latest
contributions, and ``master`` is always tagged and points to the latest
stable release.
+Code of Conduct
+------------------------
+
+Please note that Spack has a
+[**Code of Conduct**](.github/CODE_OF_CONDUCT.md). By participating in
+the Spack community, you agree to abide by its rules.
+
Authors
----------------
Many thanks go to Spack's [contributors](https://github.com/spack/spack/graphs/contributors).