github-mirror/discourse
2
0
Fork 0
mirror of https://github.com/discourse/discourse.git synced 2024-11-23 20:02:46 +08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity
8d5c900142
discourse/README.md

113 lines
6.3 KiB
Markdown
Raw Normal View History

HTTPSify links (#7046)
2019-02-22 23:29:27 +08:00
<a href="https://www.discourse.org/"><img src=
Updating README images
2019-02-05 05:52:11 +08:00
"https://user-images.githubusercontent.com/1681963/52239617-e2683480-289c-11e9-922b-5da55472e5b4.png"
width="300px"></a>
Initial release of Discourse
2013-02-06 03:16:51 +08:00
Update README.md
2017-04-12 06:11:50 +08:00
Discourse is the 100% open source discussion platform built for the next decade of the Internet. Use it as a:
Initial release of Discourse
2013-02-06 03:16:51 +08:00
Update README.md
2017-04-12 06:11:50 +08:00
- mailing list
- discussion forum
- long-form chat room
Initial release of Discourse
2013-02-06 03:16:51 +08:00
HTTPSify links (#7046)
2019-02-22 23:29:27 +08:00
To learn more about the philosophy and goals of the project, [visit **discourse.org**](https://www.discourse.org).
add link to main website at top
2013-08-10 07:35:25 +08:00
Fix typo of 'b' at the end of a heading in README
2014-03-02 16:30:11 +08:00
## Screenshots
add screenshots of live sites
2014-02-22 16:56:30 +08:00
update readme images for 1.4
2015-09-24 14:20:58 +08:00
Updating README images
2019-02-05 05:52:11 +08:00
<a href="https://bbs.boingboing.net"><img alt="Boing Boing" src="https://user-images.githubusercontent.com/1681963/52239245-04ad8280-289c-11e9-9c88-8c173d4a0422.png" width="720px"></a>
<a href="https://twittercommunity.com/"><img src="https://user-images.githubusercontent.com/1681963/52239250-04ad8280-289c-11e9-9e42-574f6eaab9d7.png" width="720px"></a>
HTTPSify links (#7046)
2019-02-22 23:29:27 +08:00
<a href="https://discuss.howtogeek.com"><img src="https://user-images.githubusercontent.com/1681963/52239247-04ad8280-289c-11e9-9706-fd66bc0749dc.png" width="720px"></a>
Updating README images
2019-02-05 05:52:11 +08:00
<a href="https://talk.turtlerockstudios.com/"><img src="https://user-images.githubusercontent.com/1681963/52239249-04ad8280-289c-11e9-9155-f0ccc5decc50.png" width="720px"></a>
add mobile screenshots to readme
2014-03-01 16:40:35 +08:00
Updating README images
2019-02-05 05:52:11 +08:00
<img src="https://user-images.githubusercontent.com/1681963/52239118-b304f800-289b-11e9-9904-16450680d9ec.jpg" alt="Mobile" width="414">
Update screenshots on Readme We had some broken images
2017-04-26 01:19:43 +08:00
Browse [lots more notable Discourse instances](https://www.discourse.org/customers).
add screenshots of live sites
2014-02-22 16:56:30 +08:00
Update README.md
2014-04-23 18:08:22 +08:00
## Development
Initial release of Discourse
2013-02-06 03:16:51 +08:00
Readme: Remove ref to old dev env blog post The old "Discourse as your first rails app" blog post points people in the direction of Vagrant, which is no longer maintained. That blog post now points people in the direction of guides that have been wiki-fied on Meta, which can also be replied to if there are questions. The existing setup guides appear to be relevant still, but the community wikis are probably better for new people to reference. If you ask me, though, there's a great debate here about whether or not setup documentation should live in this repo or on Meta -- but I don't have the answer for that. It's more important to get the effectively dead guide off the front page, since it's Hacktoberfest and I'm sure people want to contribute, but need a clear starting point.
2018-10-03 11:56:38 +08:00
To get your environment setup, follow the community setup guide for your operating system.
Initial release of Discourse
2013-02-06 03:16:51 +08:00
Readme: Remove ref to old dev env blog post The old "Discourse as your first rails app" blog post points people in the direction of Vagrant, which is no longer maintained. That blog post now points people in the direction of guides that have been wiki-fied on Meta, which can also be replied to if there are questions. The existing setup guides appear to be relevant still, but the community wikis are probably better for new people to reference. If you ask me, though, there's a great debate here about whether or not setup documentation should live in this repo or on Meta -- but I don't have the answer for that. It's more important to get the effectively dead guide off the front page, since it's Hacktoberfest and I'm sure people want to contribute, but need a clear starting point.
2018-10-03 11:56:38 +08:00
1. If you're on macOS, try the [macOS development guide](https://meta.discourse.org/t/beginners-guide-to-install-discourse-on-macos-for-development/15772).
1. If you're on Ubuntu, try the [Ubuntu development guide](https://meta.discourse.org/t/beginners-guide-to-install-discourse-on-ubuntu-for-development/14727).
1. If you're on Windows, try the [Windows 10 development guide](https://meta.discourse.org/t/beginners-guide-to-install-discourse-on-windows-10-for-development/75149).
If you're familiar with how Rails works and are comfortable setting up your own environment, you can also try out the [**Discourse Advanced Developer Guide**](docs/DEVELOPER-ADVANCED.md), which is aimed primarily at Ubuntu and macOS environments.
Update README.md - bullet pointed the getting started guide - added a reference to the Admin "How To" wiki page - clarified the developer guide as adequate for beginners
2013-03-18 01:59:24 +08:00
HTTPSify links (#7046)
2019-02-22 23:29:27 +08:00
Before you get started, ensure you have the following minimum versions: [Ruby 2.5+](https://www.ruby-lang.org/en/downloads/), [PostgreSQL 10+](https://www.postgresql.org/download/), [Redis 2.6+](https://redis.io/download). If you're having trouble, please see our [**TROUBLESHOOTING GUIDE**](docs/TROUBLESHOOTING.md) first!
Added requirements on postgres and redis-server
2013-02-08 15:38:23 +08:00
tweaks to readme
2015-09-24 14:24:45 +08:00
## Setting up Discourse
Update README.md to link to Ubuntu install guide
2013-07-01 20:00:55 +08:00
minor updates
2014-03-02 14:56:15 +08:00
If you want to set up a Discourse forum for production use, see our [**Discourse Install Guide**](docs/INSTALL.md).
update readme images for 1.4
2015-09-24 14:20:58 +08:00
If you're looking for business class hosting, see [discourse.org/buy](https://www.discourse.org/buy/).
Update README.md to link to Ubuntu install guide
2013-07-01 20:00:55 +08:00
add mobile screenshots to readme
2014-03-01 16:40:35 +08:00
## Requirements
Initial release of Discourse
2013-02-06 03:16:51 +08:00
clean up readme a bit
2013-04-11 12:25:34 +08:00
Discourse is built for the *next* 10 years of the Internet, so our requirements are high:
Initial release of Discourse
2013-02-06 03:16:51 +08:00
Change postgres version 9.5 to 10 in docs/ and README.md
2018-10-01 12:12:52 +08:00
| Browsers | Tablets | Phones |
| --------------------- | ------------ | ------------ |
Browser version bump
2019-03-26 05:11:18 +08:00
| Safari 10+ | iPad 4+ | iOS 10+ |
| Google Chrome 57+ | Android 4.4+ | Android 4.4+ |
Change postgres version 9.5 to 10 in docs/ and README.md
2018-10-01 12:12:52 +08:00
| Internet Explorer 11+ | | |
Browser version bump
2019-03-26 05:11:18 +08:00
| Firefox 52+ | | |
move requirements into a table for EZ readin'
2014-03-02 15:03:08 +08:00
rename expertise to "built with" and move it up
2013-04-11 12:47:45 +08:00
## Built With
Update README.md
2014-04-23 18:08:22 +08:00
- [Ruby on Rails](https://github.com/rails/rails) &mdash; Our back end API is a Rails app. It responds to requests RESTfully in JSON.
some &mdash; lovin'
2014-03-02 15:05:15 +08:00
- [Ember.js](https://github.com/emberjs/ember.js) &mdash; Our front end is an Ember.js app that communicates with the Rails API.
HTTPSify links (#7046)
2019-02-22 23:29:27 +08:00
- [PostgreSQL](https://www.postgresql.org/) &mdash; Our main data store is in Postgres.
- [Redis](https://redis.io/) &mdash; We use Redis as a cache and for transient data.
rename expertise to "built with" and move it up
2013-04-11 12:47:45 +08:00
link to gemfile, software.md is no good
2014-01-15 09:34:13 +08:00
Plus *lots* of Ruby Gems, a complete list of which is at [/master/Gemfile](https://github.com/discourse/discourse/blob/master/Gemfile).
rename expertise to "built with" and move it up
2013-04-11 12:47:45 +08:00
Initial release of Discourse
2013-02-06 03:16:51 +08:00
## Contributing
Link the build-status to master branch
2016-01-12 05:43:50 +08:00
[![Build Status](https://api.travis-ci.org/discourse/discourse.svg?branch=master)](https://travis-ci.org/discourse/discourse)
Added travis-ci build status image Now that discourse is using travis-ci, why not show the build status right in the README? Note: not sure where to place it... Documentation is over here: http://about.travis-ci.org/docs/user/status-images/
2013-02-08 05:46:06 +08:00
tweaks to readme
2015-09-24 14:24:45 +08:00
Discourse is **100% free** and **open source**. We encourage and support an active, healthy community that
Update README.md
2014-04-23 18:39:42 +08:00
accepts contributions from the public &ndash; including you!
Initial release of Discourse
2013-02-06 03:16:51 +08:00
omit needless words, again
2014-03-02 06:56:09 +08:00
Before contributing to Discourse:
Initial release of Discourse
2013-02-06 03:16:51 +08:00
HTTPSify links (#7046)
2019-02-22 23:29:27 +08:00
1. Please read the complete mission statements on [**discourse.org**](https://www.discourse.org). Yes we actually believe this stuff; you should too.
2. Read and sign the [**Electronic Discourse Forums Contribution License Agreement**](https://www.discourse.org/cla).
minor updates
2014-03-02 14:56:15 +08:00
3. Dig into [**CONTRIBUTING.MD**](CONTRIBUTING.md), which covers submitting bugs, requesting new features, preparing your code for a pull request, etc.
add code of conduct to project
2015-12-04 19:14:45 +08:00
4. Always strive to collaborate [with mutual respect](https://github.com/discourse/discourse/blob/master/docs/code-of-conduct.md).
HTTPSify links (#7046)
2019-02-22 23:29:27 +08:00
5. Not sure what to work on? [**We've got some ideas.**](https://meta.discourse.org/t/so-you-want-to-help-out-with-discourse/3823)
add code of conduct to project
2015-12-04 19:14:45 +08:00
Initial release of Discourse
2013-02-06 03:16:51 +08:00
add mobile screenshots to readme
2014-03-01 16:40:35 +08:00
We look forward to seeing your pull requests!
move troubleshooting after contributing
2013-03-01 02:58:45 +08:00
Add security section
2014-05-01 11:20:05 +08:00
## Security
tweaks to readme
2015-09-24 14:24:45 +08:00
We take security very seriously at Discourse; all our code is 100% open source and peer reviewed. Please read [our security guide](https://github.com/discourse/discourse/blob/master/docs/SECURITY.md) for an overview of security measures in Discourse, or if you wish to report a security issue.
Add security section
2014-05-01 11:20:05 +08:00
Initial release of Discourse
2013-02-06 03:16:51 +08:00
## The Discourse Team
HTTPSify links (#7046)
2019-02-22 23:29:27 +08:00
The original Discourse code contributors can be found in [**AUTHORS.MD**](docs/AUTHORS.md). For a complete list of the many individuals that contributed to the design and implementation of Discourse, please refer to [the official Discourse blog](https://blog.discourse.org/2013/02/the-discourse-team/) and [GitHub's list of contributors](https://github.com/discourse/discourse/contributors).
add proper deep links to team section
2013-04-11 12:45:31 +08:00
Initial release of Discourse
2013-02-06 03:16:51 +08:00
## Copyright / License
Update README license year from 2018 to 2019 (#6896)
2019-01-18 08:15:57 +08:00
Copyright 2014 - 2019 Civilized Discourse Construction Kit, Inc.
Initial release of Discourse
2013-02-06 03:16:51 +08:00
Licensed under the GNU General Public License Version 2.0 (or later);
you may not use this work except in compliance with the License.
You may obtain a copy of the License in the LICENSE file, or at:
HTTPSify links (#7046)
2019-02-22 23:29:27 +08:00
https://www.gnu.org/licenses/old-licenses/gpl-2.0.txt
Initial release of Discourse
2013-02-06 03:16:51 +08:00
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
update readme and authors
2013-02-27 17:14:44 +08:00
Discourse logo and “Discourse Forum” ®, Civilized Discourse Construction Kit, Inc.
## Dedication
HTTPSify links (#7046)
2019-02-22 23:29:27 +08:00
Discourse is built with [love, Internet style.](https://www.youtube.com/watch?v=Xe1TZaElTAs)
Reference in New Issue Copy Permalink