Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
zulip/README.md

78 lines
4.2 KiB
Markdown
Raw Normal View History

Add anchor tags to README.md.
2016-05-15 19:50:55 +02:00
# Zulip overview
Add description of Zulip at top of README.md. Based on PR #22 by GedLawrenson.
2015-09-27 03:07:06 +02:00
docs: Update the pitch at the top of README.md.
2017-11-10 03:23:11 +01:00
Zulip is a powerful, open source group chat application that combines the
immediacy of real-time chat with the productivity benefits of threaded
conversations. Zulip is used by open source projects, Fortune 500 companies,
docs: Split a CONTRIBUTING.md out of README.md. Also contains a number of updates, additions, and deletions; this is essentially a rewrite of the github landing page experience.
2017-11-13 23:12:16 +01:00
large standards bodies, and others who need a real-time chat system that
allows users to easily process hundreds or thousands of messages a day. With
docs: Update contributor count to over 500.
2019-06-03 21:13:38 +02:00
over 500 contributors merging over 500 commits a month, Zulip is also the
docs: Split a CONTRIBUTING.md out of README.md. Also contains a number of updates, additions, and deletions; this is essentially a rewrite of the github landing page experience.
2017-11-13 23:12:16 +01:00
largest and fastest growing open source group chat project.
Expand documentation on contributing to Zulip.
2015-10-17 20:16:13 +02:00
README: Improve links to coverage/CI to point to master. Apparently, the CircleCI and Codecov links (and the Codecov badge) weren't pointing specifically at master, so they'd sometimes show state from the lastest push to a pull request, which isn't a reasonable way to advertise whether the project's build is passing.
2019-10-02 00:27:36 +02:00
[![CircleCI branch](https://img.shields.io/circleci/project/github/zulip/zulip/master.svg)](https://circleci.com/gh/zulip/zulip/tree/master)
[![Coverage Status](https://img.shields.io/codecov/c/github/zulip/zulip/master.svg)](https://codecov.io/gh/zulip/zulip/branch/master)
lint: Fix long lines in README.md.
2017-11-16 20:38:13 +01:00
[![Mypy coverage](https://img.shields.io/badge/mypy-100%25-green.svg)][mypy-coverage]
README: Add latest GitHub release badge to README.
2018-11-16 05:07:15 +01:00
[![GitHub release](https://img.shields.io/github/release/zulip/zulip.svg)](https://github.com/zulip/zulip/releases/latest)
docs: Update links to ReadTheDocs to always use https. This is better security practice. We also add a lint rule to enforce this for the future.
2017-11-16 19:54:24 +01:00
[![docs](https://readthedocs.org/projects/zulip/badge/?version=latest)](https://zulip.readthedocs.io/en/latest/)
README: Wrap GitHub badges to be one line for each badges. Apparently, we no longer need to do the hacky no-line-wrapping thing we were doing for these to work.
2017-09-29 07:39:04 +02:00
[![Zulip chat](https://img.shields.io/badge/zulip-join_chat-brightgreen.svg)](https://chat.zulip.org)
lint: Fix long lines in README.md.
2017-11-16 20:38:13 +01:00
[![Twitter](https://img.shields.io/badge/twitter-@zulip-blue.svg?style=flat)](https://twitter.com/zulip)
[mypy-coverage]: https://blog.zulip.org/2016/10/13/static-types-in-python-oh-mypy/
Add Travis CI button to README.md
2016-02-21 01:47:04 +01:00
docs: Make minor updates to CONTRIBUTING.md and README.md.
2017-11-15 06:30:41 +01:00
## Getting started
docs: Split a CONTRIBUTING.md out of README.md. Also contains a number of updates, additions, and deletions; this is essentially a rewrite of the github landing page experience.
2017-11-13 23:12:16 +01:00
Click on the appropriate link below. If nothing seems to apply,
join us on the
docs: Update absolute links to point to new URLs. This should get test-documentation and test-help-documentation passing again after we moved everything around in the last commit. There are a lot more absolute links (generally in code comments) to update, but they are lower-priority and can be done in a follow-up pass.
2017-11-16 18:54:01 +01:00
[Zulip community server](https://zulip.readthedocs.io/en/latest/contributing/chat-zulip-org.html)
docs: Split a CONTRIBUTING.md out of README.md. Also contains a number of updates, additions, and deletions; this is essentially a rewrite of the github landing page experience.
2017-11-13 23:12:16 +01:00
and tell us what's up!
docs: Make minor updates to CONTRIBUTING.md and README.md.
2017-11-15 06:30:41 +01:00
You might be interested in:
docs: Split a CONTRIBUTING.md out of README.md. Also contains a number of updates, additions, and deletions; this is essentially a rewrite of the github landing page experience.
2017-11-13 23:12:16 +01:00
* **Contributing code**. Check out our
docs: Update absolute links to point to new URLs. This should get test-documentation and test-help-documentation passing again after we moved everything around in the last commit. There are a lot more absolute links (generally in code comments) to update, but they are lower-priority and can be done in a follow-up pass.
2017-11-16 18:54:01 +01:00
[guide for new contributors](https://zulip.readthedocs.io/en/latest/overview/contributing.html)
docs: Update discussion of outreach programs. "Outreach programs" I think is better phrasing than "Internship programs", since GSoC is the main one we do these days and isn't an internship program. This may fail CI since it contains links to anchors on ReadTheDocs that may race; it should fail ones the ReadTheDocs build completes.
2020-02-25 20:44:52 +01:00
to get started. Zulip prides itself on maintaining a clean and
lint: Fix long lines in README.md.
2017-11-16 20:38:13 +01:00
well-tested codebase, and a stock of hundreds of
[beginner-friendly issues][beginner-friendly].
docs: Split a CONTRIBUTING.md out of README.md. Also contains a number of updates, additions, and deletions; this is essentially a rewrite of the github landing page experience.
2017-11-13 23:12:16 +01:00
* **Contributing non-code**.
docs: Update absolute links to point to new URLs. This should get test-documentation and test-help-documentation passing again after we moved everything around in the last commit. There are a lot more absolute links (generally in code comments) to update, but they are lower-priority and can be done in a follow-up pass.
2017-11-16 18:54:01 +01:00
[Report an issue](https://zulip.readthedocs.io/en/latest/overview/contributing.html#reporting-issue),
[translate](https://zulip.readthedocs.io/en/latest/translating/translating.html) Zulip
docs: Split a CONTRIBUTING.md out of README.md. Also contains a number of updates, additions, and deletions; this is essentially a rewrite of the github landing page experience.
2017-11-13 23:12:16 +01:00
into your language,
docs: Update absolute links to point to new URLs. This should get test-documentation and test-help-documentation passing again after we moved everything around in the last commit. There are a lot more absolute links (generally in code comments) to update, but they are lower-priority and can be done in a follow-up pass.
2017-11-16 18:54:01 +01:00
[write](https://zulip.readthedocs.io/en/latest/overview/contributing.html#zulip-outreach)
docs: Split a CONTRIBUTING.md out of README.md. Also contains a number of updates, additions, and deletions; this is essentially a rewrite of the github landing page experience.
2017-11-13 23:12:16 +01:00
for the Zulip blog, or
docs: Update absolute links to point to new URLs. This should get test-documentation and test-help-documentation passing again after we moved everything around in the last commit. There are a lot more absolute links (generally in code comments) to update, but they are lower-priority and can be done in a follow-up pass.
2017-11-16 18:54:01 +01:00
[give us feedback](https://zulip.readthedocs.io/en/latest/overview/contributing.html#user-feedback). We
docs: Split a CONTRIBUTING.md out of README.md. Also contains a number of updates, additions, and deletions; this is essentially a rewrite of the github landing page experience.
2017-11-13 23:12:16 +01:00
would love to hear from you, even if you're just trying the product out.
* **Supporting Zulip**. Advocate for your organization to use Zulip, write a
review in the mobile app stores, or
docs: Update absolute links to point to new URLs. This should get test-documentation and test-help-documentation passing again after we moved everything around in the last commit. There are a lot more absolute links (generally in code comments) to update, but they are lower-priority and can be done in a follow-up pass.
2017-11-16 18:54:01 +01:00
[upvote Zulip](https://zulip.readthedocs.io/en/latest/overview/contributing.html#zulip-outreach) on
docs: Split a CONTRIBUTING.md out of README.md. Also contains a number of updates, additions, and deletions; this is essentially a rewrite of the github landing page experience.
2017-11-13 23:12:16 +01:00
product comparison sites.
* **Checking Zulip out**. The best way to see Zulip in action is to drop by
the
docs: Update absolute links to point to new URLs. This should get test-documentation and test-help-documentation passing again after we moved everything around in the last commit. There are a lot more absolute links (generally in code comments) to update, but they are lower-priority and can be done in a follow-up pass.
2017-11-16 18:54:01 +01:00
[Zulip community server](https://zulip.readthedocs.io/en/latest/contributing/chat-zulip-org.html). We
docs: Split a CONTRIBUTING.md out of README.md. Also contains a number of updates, additions, and deletions; this is essentially a rewrite of the github landing page experience.
2017-11-13 23:12:16 +01:00
also recommend reading Zulip for
[open source](https://zulipchat.com/for/open-source/), Zulip for
[companies](https://zulipchat.com/for/companies/), or Zulip for
[working groups and part time communities](https://zulipchat.com/for/working-groups-and-communities/).
readme: Advertise digital ocean droplet and docker install.
2019-08-26 22:57:41 +02:00
* **Running a Zulip server**. Use a preconfigured [Digital Ocean droplet](https://marketplace.digitalocean.com/apps/zulip),
[install Zulip](https://zulip.readthedocs.io/en/stable/production/install.html)
directly, or use Zulip's
experimental [Docker image](https://zulip.readthedocs.io/en/latest/production/deployment.html#zulip-in-docker).
Commercial support is available; see <https://zulipchat.com/plans> for details.
docs: Split a CONTRIBUTING.md out of README.md. Also contains a number of updates, additions, and deletions; this is essentially a rewrite of the github landing page experience.
2017-11-13 23:12:16 +01:00
docs: Update discussion of outreach programs. "Outreach programs" I think is better phrasing than "Internship programs", since GSoC is the main one we do these days and isn't an internship program. This may fail CI since it contains links to anchors on ReadTheDocs that may race; it should fail ones the ReadTheDocs build completes.
2020-02-25 20:44:52 +01:00
* **Using Zulip without setting up a server**. <https://zulipchat.com>
offers free and commercial hosting, including providing our paid
plan for free to fellow open source projects.
docs: Split a CONTRIBUTING.md out of README.md. Also contains a number of updates, additions, and deletions; this is essentially a rewrite of the github landing page experience.
2017-11-13 23:12:16 +01:00
docs: Update discussion of outreach programs. "Outreach programs" I think is better phrasing than "Internship programs", since GSoC is the main one we do these days and isn't an internship program. This may fail CI since it contains links to anchors on ReadTheDocs that may race; it should fail ones the ReadTheDocs build completes.
2020-02-25 20:44:52 +01:00
* **Participating in [outreach
programs](https://zulip.readthedocs.io/en/latest/overview/contributing.html#outreach-programs)**
like Google Summer of Code.
docs: Split a CONTRIBUTING.md out of README.md. Also contains a number of updates, additions, and deletions; this is essentially a rewrite of the github landing page experience.
2017-11-13 23:12:16 +01:00
You may also be interested in reading our [blog](http://blog.zulip.org/) or
following us on [twitter](https://twitter.com/zulip).
docs: Move license declaration from README.md to LICENSE.
2017-11-14 21:21:05 +01:00
Zulip is distributed under the
[Apache 2.0](https://github.com/zulip/zulip/blob/master/LICENSE) license.
docs: Fix unintentional whitespace in ReadTheDocs homepage.
2017-11-17 19:45:55 +01:00
[beginner-friendly]: https://github.com/zulip/zulip/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22