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

88 lines
4.9 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 README.md description.
2022-01-07 00:21:27 +01:00
[Zulip](https://zulip.com) is an open-source team collaboration tool with unique
[topic-based threading][why-zulip] that combines the best of email and chat to
make remote work productive and delightful. Fortune 500 companies, [leading open
source projects][rust-case-study], and thousands of other organizations use
Zulip every day. Zulip is the only [modern team chat app][features] that is
designed for both live and asynchronous conversations.
Zulip is built by a distributed community of developers from all around the
world, with 74+ people who have each contributed 100+ commits. With
over 700 contributors merging over 500 commits a month, Zulip is the
largest and fastest growing open source team chat project.
Expand documentation on contributing to Zulip.
2015-10-17 20:16:13 +02:00
Rename default branch to ‘main’. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-09-01 00:15:31 +02:00
[![GitHub Actions build status](https://github.com/zulip/zulip/actions/workflows/zulip-ci.yml/badge.svg)](https://github.com/zulip/zulip/actions/workflows/zulip-ci.yml?query=branch%3Amain)
[![coverage status](https://img.shields.io/codecov/c/github/zulip/zulip/main.svg)](https://codecov.io/gh/zulip/zulip)
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]
docs: Document Black and isort. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-02-13 00:21:10 +01:00
[![code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
docs: Document that we use Prettier. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2020-07-22 21:25:49 +02:00
[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
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)
readme: Add GitHub sponsors badge in README. The number is really low, since we haven't told anyone about our GitHub Sponsors site, so the badge probably isn't actually helpful, but I suppose that's OK.
2021-03-08 12:40:01 +01:00
[![GitHub Sponsors](https://img.shields.io/github/sponsors/zulip)](https://github.com/sponsors/zulip)
lint: Fix long lines in README.md.
2017-11-16 20:38:13 +01:00
[mypy-coverage]: https://blog.zulip.org/2016/10/13/static-types-in-python-oh-mypy/
docs: Update README.md description.
2022-01-07 00:21:27 +01:00
[why-zulip]: https://zulip.com/why-zulip/
[rust-case-study]: https://zulip.com/case-studies/rust/
[features]: https://zulip.com/features/
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
external links: Migrate the rest of /developer-community links. We recently changed /developer-community to /development-community. Now that this change is in production, we can also migrate the external links in our ReadTheDocs documentation.
2021-12-09 20:15:18 +01:00
[Zulip community server](https://zulip.com/development-community/)
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
docs: Apply bullet style changes from Prettier. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-08-20 21:45:39 +02: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: Apply sentence single-spacing from Prettier. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-08-20 21:53:28 +02: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: Apply bullet style changes from Prettier. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-08-20 21:45:39 +02:00
- **Contributing non-code**.
docs: Fix "report an issue" link in README.md. This link has been broken since it was added in November 2017, when CONTRIBUTING.md was split out of README.md in ee2ea3750c43c7b86a8e02b0b1c4575fb0387a19.
2020-06-02 02:27:25 +02:00
[Report an issue](https://zulip.readthedocs.io/en/latest/overview/contributing.html#reporting-issues),
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
[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.
docs: Apply bullet style changes from Prettier. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-08-20 21:45:39 +02:00
- **Supporting Zulip**. Advocate for your organization to use Zulip, become a [sponsor](https://github.com/sponsors/zulip), write a
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
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.
docs: Apply bullet style changes from Prettier. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-08-20 21:45:39 +02:00
- **Checking Zulip out**. The best way to see Zulip in action is to drop by
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
the
external links: Migrate the rest of /developer-community links. We recently changed /developer-community to /development-community. Now that this change is in production, we can also migrate the external links in our ReadTheDocs documentation.
2021-12-09 20:15:18 +01:00
[Zulip community server](https://zulip.com/development-community/). 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
docs: Update URLs to use https://zulip.com. We're migrating to using the cleaner zulip.com domain, which involves changing all of our links from ReadTheDocs and other places to point to the cleaner URL.
2020-06-08 23:04:39 +02:00
[open source](https://zulip.com/for/open-source/), Zulip for
[companies](https://zulip.com/for/companies/), or Zulip for
portico: Create new "Zulip for communities" page.
2021-07-17 00:37:09 +02:00
[communities](https://zulip.com/for/working-groups-and-communities/).
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: Apply bullet style changes from Prettier. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-08-20 21:45:39 +02:00
- **Running a Zulip server**. Use a preconfigured [DigitalOcean droplet](https://marketplace.digitalocean.com/apps/zulip),
readme: Advertise digital ocean droplet and docker install.
2019-08-26 22:57:41 +02:00
[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).
docs: Update URLs to use https://zulip.com. We're migrating to using the cleaner zulip.com domain, which involves changing all of our links from ReadTheDocs and other places to point to the cleaner URL.
2020-06-08 23:04:39 +02:00
Commercial support is available; see <https://zulip.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: Apply bullet style changes from Prettier. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-08-20 21:45:39 +02:00
- **Using Zulip without setting up a server**. <https://zulip.com>
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
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: Apply bullet style changes from Prettier. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-08-20 21:45:39 +02:00
- **Participating in [outreach
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
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
docs: Convert many http URLs to https. Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-03-27 01:32:21 +01:00
You may also be interested in reading our [blog](https://blog.zulip.org/) or
docs: Fix various capitalization errors. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2020-08-11 01:47:54 +02:00
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
Rename default branch to ‘main’. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-09-01 00:15:31 +02:00
[Apache 2.0](https://github.com/zulip/zulip/blob/main/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