summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJoshua M. Clulow <josh@sysmgr.org>2019-10-18 19:57:40 -0700
committerJoshua M. Clulow <josh@sysmgr.org>2019-10-18 19:57:40 -0700
commitc03d3c922b91c3e21b9cb32baec32e254a141bb0 (patch)
tree22f370431333c20d9fb9a55405a9f0e06fbe5e99 /README.md
parent1b5fde4ead97be960bc3ea43dd9491cef5604668 (diff)
downloadillumos-joyent-c03d3c922b91c3e21b9cb32baec32e254a141bb0.tar.gz
11772 adopt a Code of Conduct for the illumos project
11771 convert README to markdown Reviewed by: Robert Mustacchi <rm@fingolfin.org> Reviewed by: Dan McDonald <danmcd@joyent.com> Reviewed by: Richard Lowe <richlowe@richlowe.net> Reviewed by: Garrett D'Amore <garrett@damore.org> Approved by: Garrett D'Amore <garrett@damore.org>
Diffstat (limited to 'README.md')
-rw-r--r--README.md41
1 files changed, 41 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000000..e92b6c179c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,41 @@
+# illumos-gate
+
+This is the core [illumos](https://illumos.org) source tree.
+
+## Building
+
+The illumos build must be run on an illumos-based operating system. See the
+[Building illumos](https://illumos.org/docs/developers/build/) section of our
+documentation for detailed instructions.
+
+## Contributing
+
+Code changes must be reviewed and tested. If you'd like to submit a change for
+inclusion in the project, please see the [Contributing to
+illumos](https://illumos.org/docs/contributing/) guide in our documentation.
+
+## Community
+
+The illumos community is small but active. We welcome everybody who would like
+to use the software and participate in the community -- whether you've decades
+of experience in systems software, or you're just getting started; whether you
+work for a company that uses illumos, or you just find it personally
+interesting.
+
+Our [Community](https://illumos.org/docs/community/) guide includes details
+about our Mailing Lists and IRC channels.
+
+## Code of Conduct
+
+Participation in our community spaces, and in the project in general, are
+covered by our [Code of Conduct](./CODE_OF_CONDUCT.md). By participating in
+the project you agree to abide by its terms.
+
+## License
+
+Most of the existing code is licensed under the
+[CDDL](https://illumos.org/license/CDDL) and we expect new code will generally
+be under this license as well. Modifications of existing code may not alter
+the original license terms. Integrations of code from upstream sources that
+use another open source license are permissible, subject to approval of the
+advocates.