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