Commit Graph

147 Commits

Author SHA1 Message Date
Vaida Plankyte 984108ac90 README.md: Add link to bug report guidelines.
Fixes #1028.
2017-08-09 11:38:46 -07:00
Tim Abbott 3425d83f52 twitter: Update links to point to our new Twitter username. 2017-08-01 17:13:33 -07:00
Cynthia Lin 9777496046 repository: Update information with Codecov migration. 2017-06-20 07:17:39 -04:00
Joshua Pan 414df5ef8b Add Twitter badge to README. 2017-06-12 21:13:28 -07:00
Greg Price 89a15e67de README: Harmonize references to development list and chat.
Also update one reference to the list to instead point to
a chat stream.
2017-06-08 13:44:27 -07:00
Greg Price b805f21f80 README: Fix some formatting and add some links in final section.
The `<foo>` was rendering empty, I think because the Markdown
processor was interpreting it as a malformed attempt at HTML,
so that it read 'our "area:" convention'.
2017-06-07 22:08:54 -07:00
Greg Price 1e478bb50f README: Update discussion of mobile apps and of GSoC.
Now that GSoC 2017 is underway, there's no need to say much
about the application process.

That section is now very short and doesn't feel like it
really fits with the other sections around.  But the remaining
content seems like interesting stuff that's nice to have
in the README so that e.g. it's linked from the repo's
front page on GitHub.  Leaving further refactoring to
another day.
2017-06-07 22:05:52 -07:00
Tim Abbott 7a545eeb13 docs: Update copyright notices for 2017.
Also record Kandra Labs, Inc., as a major copyright holder.
2017-05-16 19:04:59 -07:00
Sumana Harihareswara d4b56df5e4 docs: Guide developer questions to GitHub and chat. 2017-03-24 12:07:14 -07:00
Saumya Bhatnagar 1a6efc9705 README: Update GSoC section to mention android plan. 2017-03-21 20:16:27 -07:00
Yago González a5ecb5e5cf docs: Fix minor link formatting. 2017-03-19 09:16:06 -07:00
Tim Abbott 5cc900eca6 README: Rename peer review -> code review. 2017-03-08 11:44:33 -08:00
Tim Abbott d681ef470d docs: Fully desupport the old iOS app. 2017-03-07 16:48:27 -08:00
Saket Kumar 1079e516a4 README: Update GSoC section.
Updated GSoC section to indicate zulip is participating again in 2017.
2017-03-04 19:06:33 -08:00
Joshua Pan 8514df180b README.md: fix https://www.zulip.org link 2017-02-27 22:19:34 -08:00
Joshua Pan 4db73b4e91 README.md: change relative links to absolute links 2017-02-26 22:24:56 -08:00
Tim Abbott 9cd6bb4251 README: Tweak peer review stream docs. 2017-02-26 21:22:13 -08:00
Joshua Pan 75e8cd5a6a README.md: Document peer review stream. Fixes #3395. 2017-02-26 21:19:38 -08:00
lonerz d09c8b42c1 docs: Update README.md with @zulipbot details. Fixes #3752. 2017-02-22 22:38:06 -08:00
Tim Abbott 9eaa0472d5 docs: Update links to point to new chat-zulip-org.html. 2017-02-12 16:57:14 -08:00
Tim Abbott 35ab9de53c docs: Document chat.zulip.org. 2017-02-12 16:57:11 -08:00
Feorlen 74ca33d015 Describe the WIP PR process in Zulip overview doc.
Add new text in the Ways to contribute section to encourage early PRs.
2017-02-10 21:42:38 -08:00
Tim Abbott 975ede6c83 README: Fix Zulip docs badge. 2017-02-06 15:50:24 -08:00
Tim Abbott efb8f8c26d docs: Wrap a bunch of long lines. 2017-01-05 14:31:34 -08:00
Tommy Ip 8e86ed7364 Improve join chat button.
Update join chat button to match with other badges in README.md.
2016-12-21 10:51:54 -08:00
anirudhjain75 db894b9912 Create "join chat" button for Zulip.
The image that we are using can be found in the zulip repository
in the directory`static/images/help` named as chat-with-zulip-button.

We use the new button in the readme, and we also provide instructions
on how to embed the button in other sites in the help docs.

Fixes: #2270
2016-12-20 16:10:21 -08:00
Tim Abbott ad9c3d7d18 README: Reframe discussion of our Google group. 2016-12-13 22:31:16 -08:00
Sumana Harihareswara ef439bb809 Reduce mailing list links in README for GSoC funnelling.
The zulip-devel mailing list is receiving enough low-quality
interest emails from people interested in GSoC that we
are reducing the number of links to the list in the README,
and adding more wording to funnel GSoC applicants to the
appropriate venues.
2016-12-13 22:29:42 -08:00
Tim Abbott eea59c1c9c docs: Add RTD link badge. 2016-11-26 19:10:39 -08:00
Michael Cordover 4047c7d3c4 docs: Add code of conduct. 2016-11-26 18:40:16 -08:00
sinwar 67d99c536a docs: change zulip.tabbott.net to chat.zulip.org 2016-11-03 16:07:59 -07:00
K.Kanakhin 9492bd37b4 docs-test: Fix documentation links.
- Fix internal documentation links and anchors according last project documentation version.

Fixes #1492
2016-10-22 19:30:24 -07:00
Sumana Harihareswara fe711208fb docs: Capitalize GitHub properly. 2016-10-19 12:36:20 -07:00
Tim Abbott 08729d35ad README.md: Add mention of our blog and tweak intro. 2016-10-19 12:19:57 -07:00
Sumana Harihareswara 3b74ed20fa Add GSoC mailing list link to README.md. 2016-10-19 12:14:51 -07:00
Steve Howell 6a482a65d4 Document our "area:" labeling convention in README.md. 2016-10-18 17:12:06 -07:00
Steve Howell 9afc130f21 Use "area:<label>" for doc links in README.md. 2016-10-18 17:10:57 -07:00
Arpith Siromoney ddaf44e533 Add link to zulip-js in README. 2016-09-23 10:46:17 -07:00
Tim Abbott f443fcea48 README.md: Document Ubuntu 16.04 support. 2016-08-26 21:25:17 -07:00
saket14 83a05c2821 docs: Fix duplicate word in README.md. 2016-08-26 19:08:10 -07:00
Tim Abbott 9001bebf2f Move THIRDPARTY to docs/ subdirectory. 2016-08-25 20:02:42 -07:00
Tim Abbott 5a065503cb docs: Update copyright license dates to include 2016. 2016-08-25 16:31:15 -07:00
Tim Abbott f6c4e46afe docs: Move README.dev.md into ReadTheDocs.
Fixes: #669.
2016-08-25 10:40:51 -07:00
Steve Howell bf6a9ebe8a docs: Add Community links to the overview page. 2016-08-19 09:54:17 -07:00
Sumana Harihareswara 2d43431ad9 Advertise Electron app in documentation. 2016-08-02 16:41:24 -07:00
Sumana Harihareswara db6c9702c2 Update links in README and integration guide. 2016-07-19 14:57:07 -07:00
Sumana Harihareswara 6ed73b430a Change doc links to point to RTD for prod docs. 2016-07-12 15:46:10 -07:00
Krit Karan 406cce7027 README: Repoint translating documentation at RTD. 2016-07-01 10:11:48 -07:00
Krit Karan 6c38023cbb REAMDE: Fix (transifex) to [transifex].
This caused the Transifex link to be broken.
2016-07-01 10:11:33 -07:00
Tim Abbott ddd44189a9 Fix coverage reporting on GitHub homepage.
The previous Markdown syntax didn't work correctly on ReadTheDocs, and
now that we have Coveralls reporting backend test coverage as well,
describing our coverage as just "mypy static type" is no longer accurate.

Fixes #964.
2016-06-10 18:48:14 -07:00
Taranjeet c6cfd21bd4 Readme: Fix links for readme.dev and readme.prod.
Absolute links is necessary for readthedocs to properly
link to the files.
2016-06-04 14:15:08 -07:00
Tim Abbott 697125eeae Fix coveralls badge to point to the right branch. 2016-06-04 14:11:21 -07:00
Reid Barton a0f906edf9 Add mypy coverage status to README.md. 2016-06-04 13:01:19 -07:00
Sumana Harihareswara cb6ae3a766 Add anchor tags to README.md. 2016-05-31 11:27:21 -07:00
Sumana Harihareswara 5f053e0047 Add remaining codebases to README.md.
The README should link to all the Zulip codebases. Also, it makes
sense to split up app code from integration and other glue code.

Fixes: #674.
2016-05-17 16:56:46 -07:00
Sumana Harihareswara 34d2c505e9 Fix typos in README.md. 2016-05-13 22:18:20 -07:00
Sumana Harihareswara 038c1ea20f Add integration project links to README.
The README should link to all Zulip-specific open source projects
so users know where to file bugs and code contributors can pitch
in.

Fixes: #674.
2016-05-12 13:45:20 -07:00
Tim Abbott f06c8c7cc2 Update *.readthedocs.org => *.readthedocs.io.
ReadTheDocs has moved their hosting of user project websites to the
new readthedocs.io domain.
2016-04-29 16:00:08 -07:00
Tim Abbott 4c3118b39f Document new zulip-ios mailing list. 2016-04-29 14:21:01 -07:00
Tim Abbott 362a622f1f Add documentation on translating Zulip. 2016-04-28 21:57:10 -07:00
Tim Abbott 27b8e8b294 Add the Zulip 2016 roadmap document. 2016-04-28 21:55:33 -07:00
Tim Abbott a626f4558c README.md: Clean up guide to new contributions. 2016-04-28 21:07:42 -07:00
Tim Abbott 342b4eb457 Add a detailed integration writing guide.
Fixes: #70.
2016-04-01 09:56:59 -07:00
Luke Faraone 85d2e8d249 Add missing periods to some bullet point headings 2016-03-21 05:42:40 +00:00
Luke Faraone 27e346302c Consistently use ':'s when describing bugs in README.md. 2016-03-21 03:51:50 +00:00
Luke Faraone d93a2bcf11 Reformat README.*.md to 70 characters uniformly.
There are some stragglers, but this is better than the previous SOTW
where line length was all over the place.
2016-03-21 03:51:49 +00:00
Karambir Singh Nain fc0a414fe6 Fixed markdown links in README and README.dev
[Patched with some tweaks by tabbott]
2016-03-08 08:44:44 -08:00
Luke Faraone c8de86894f Add Travis CI button to README.md 2016-02-21 00:47:04 +00:00
Tim Abbott 55ddc35b90 Move development installations instructions to a separate file.
This will make the core README.md file cleaner.
2015-11-06 09:45:41 -08:00
Tim Abbott 8181a0423f Fix some small issues with the CentOS/Fedora instructions. 2015-11-06 09:45:41 -08:00
Марко М. Костић (Marko M. Kostić) 7f4b82af18 Added CentOS 7 specific instructions to the manual install guide. 2015-11-06 09:45:41 -08:00
Gautam Kotian fb5192e85b Fix typo in README.md. 2015-10-26 20:04:55 -07:00
Tim Abbott b76e78c4dd Expand documentation on contributing to Zulip. 2015-10-19 21:01:18 -07:00
Tim Abbott 3e735d36d1 Rename tools/postgres-init-db to tools/postgres-init-dev-db.
The previous name was confusing because we also have
scripts/setup/postgres-init-db.
2015-10-15 09:14:21 -04:00
Tim Abbott 5ee50cdced Install libfreetype6-dev in the development environment.
This fixes a problem where the emoji_dump tool was not generating the
black-and-white emoji.  The issue is that Pillow compiled without
libfreetype cannot extract those emoji (and gives an error of the form
"The _imagingft C module is not installed"), and if libfreetype-dev
isn't installed, pip will happily build and install Pillow without
libfreetype.
2015-10-14 18:58:36 -04:00
Tim Abbott 1dc09f3abd Document need to restart run-dev.py when developing queue workers. 2015-10-14 16:11:04 -04:00
Tim Abbott 0d85ab2062 README: Clean up Mac installation instructions for Virtualbox/Vagrant.
* Removes the hardcoding of an old version of Virtualbox (and doesn't
  specify the version to avoid getting stale again over time).
* Flips around the langauge to assume you don't have Vagrant already.
* Makes clear that the first-time installation is a lot slower than
  future runs will be.

Fixes #5.
2015-10-14 12:05:23 -04:00
David Farrell 59dfec8f8b Add Fedora-specific instructions to the manual install guide. 2015-10-07 15:23:59 -04:00
Darius Bacon 741e9d00d8 Install zulip_english.stop in 'By hand' install instructions.
This step was previously only present in provision.py.
2015-10-06 23:00:18 -04:00
David Farrell e4cea98ccd Correct the filepath for rebuild test database script. 2015-10-05 21:28:54 -04:00
Luna Lunapiena 0ec99a0838 README: Add explicit instruction to clone Zulip repository. 2015-10-05 21:27:08 -04:00
David Farrell 411531ecaf Update script paths in by-hand instructions to execute as written. 2015-10-05 20:36:07 -04:00
Nicholas Bergson-Shilcock 759ab33981 Add note about installing Vagrant on Mac to README. 2015-10-05 20:34:27 -04:00
Justin Valentini d490779307 Add a relative link to production README. 2015-10-04 16:28:36 +00:00
Tim Abbott f819c1e901 Update the Zulip development documentation.
Fixes a few major issues:
* Documents RAM requirements for running Zulip development
* Fixes missing steps in the "by hand" installation process
* Improves the emphasis in the section no how to run tests on the common case.
* Documents that you can use LXC on newer Ubuntu as well.
2015-09-30 09:04:16 -07:00
Amanpreet Singh e20bc9f9b3 Fix "by hand" installation instructions.
- Add missing `python-dev` in apt-get install command
2015-09-28 09:24:55 -07:00
Ian Whitlock 54fd321941 Add Vagrant-caused permissions problem to Possible Issues. 2015-09-27 17:48:07 -07:00
Tim Abbott e5f7000a23 Add description of Zulip at top of README.md.
Based on PR #22 by GedLawrenson.
2015-09-26 18:07:06 -07:00
Tim Abbott 3f76745235 Reorder README.md to highlight contributing section earlier. 2015-09-26 14:02:28 -07:00
Alice Pote 8159c03205 Add backticks around 'apt-get install'. 2015-09-26 12:13:21 -07:00
Thomas Boyt 1d40b2291c Fix Markdown formatting of code blocks & snippets 2015-09-25 12:07:55 -07:00
acrefoot 5accdf6d69 Add vagrant-lxc step to README.md
(imported from commit 1c0796dd70f535d11f492cb144b71ce3f34d3d4a)
2015-09-25 08:47:46 -07:00
Tim Abbott 441fa8ed9d Add build_emoji command to by-hand setup instructions.
(imported from commit 343ee4bc6397ba52c9bf1d2563c54a0470e3478b)
2015-09-25 00:44:20 -07:00
Luke Faraone 11a51cf943 License disclosures and project licensing.
(imported from commit 65776787f62e954ed22a521968effa4559fd6d33)
2015-09-25 00:44:19 -07:00
Tim Abbott ce5e9093e6 Add missing --interface option for run-dev.py.
(imported from commit 94628eaa4d62597eda44f6f53be8bde4dfc33cfc)
2015-09-24 19:34:28 -07:00
Tim Abbott ca4db5ac4b Extent contributing section in README.md.
(imported from commit 8d0a56f9450419a10b12d40437213b9b7184f8bd)
2015-09-24 19:34:28 -07:00
Tim Abbott ac8167062b Markdownify README files and add contribution documentation in README.md.
(imported from commit aac3bc2d051dd328cb55be05fd44d77b626e1201)
2015-09-22 21:43:54 -07:00