Skip to content
Snippets Groups Projects
Commit af393905 authored by Todd Gamblin's avatar Todd Gamblin
Browse files

README: Tighten up text, mention the Code of Conduct in the README.

parent 9c37a4c9
No related branches found
No related tags found
No related merge requests found
...@@ -26,55 +26,45 @@ Then: ...@@ -26,55 +26,45 @@ Then:
$ git clone https://github.com/spack/spack.git $ git clone https://github.com/spack/spack.git
$ cd spack/bin $ cd spack/bin
$ ./spack install libelf $ ./spack install zlib
Documentation Documentation
---------------- ----------------
[**Full documentation**](http://spack.readthedocs.io/) for Spack is [**Full documentation**](http://spack.readthedocs.io/) is available, or
the first place to look. run `spack help` or `spack help --all`.
Try the Tutorial
[**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. 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: Feel free to use these materials to teach users at your organization
* [Technical paper](http://www.computer.org/csdl/proceedings/sc/2015/3723/00/2807623.pdf) and about Spack.
[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.
Get Involved! Community
------------------------ ------------------------
Spack is an open source project. Questions, discussion, and Spack is an open source project. Questions, discussion, and
contributions are welcome. Contributions can be anything from new contributions are welcome. Contributions can be anything from new
packages to bugfixes, or even new core features. packages to bugfixes, documentation, 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:
* [Spack on Slack](https://spackpm.slack.com) **Resources:**
[Sign up here](https://spackpm.herokuapp.com) to get an invitation mailed * **Slack workspace**: [spackpm.slack.com](https://spackpm.slack.com).
to you. Open to anyone; visit
[spackpm.herokuapp.com](https://spackpm.herokuapp.com) to have an
### Twitter invitation emailed to you automatically.
* **Mailing list**: https://groups.google.com/d/forum/spack
You can follow [@spackpm](https://twitter.com/spackpm) on Twitter for * **Twitter**: [@spackpm](https://twitter.com/spackpm). Be sure to
updates. Also, feel free to `@mention` us in in questions or comments `@mention` us!
about your own experience with Spack.
### Contributions
Contributing
------------------------
Contributing to Spack is relatively easy. Just send us a Contributing to Spack is relatively easy. Just send us a
[pull request](https://help.github.com/articles/using-pull-requests/). [pull request](https://help.github.com/articles/using-pull-requests/).
When you send your request, make ``develop`` the destination branch on the When you send your request, make ``develop`` the destination branch on the
...@@ -92,6 +82,13 @@ branching model. The ``develop`` branch contains the latest ...@@ -92,6 +82,13 @@ branching model. The ``develop`` branch contains the latest
contributions, and ``master`` is always tagged and points to the latest contributions, and ``master`` is always tagged and points to the latest
stable release. 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 Authors
---------------- ----------------
Many thanks go to Spack's [contributors](https://github.com/spack/spack/graphs/contributors). Many thanks go to Spack's [contributors](https://github.com/spack/spack/graphs/contributors).
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment