mirror of https://github.com/flarum/flarum
Update urls with their current canonical versions (#54)
parent
995a2621db
commit
a82b4f209f
|
@ -4,7 +4,7 @@ Howdy! We're really excited that you are interested in contributing to Flarum. B
|
||||||
|
|
||||||
## Reporting Bugs
|
## Reporting Bugs
|
||||||
|
|
||||||
- Before opening an issue, debug your problem by following [these instructions](http://flarum.org/docs/contributing). Only open an issue if you are confident it is a bug with Flarum, not with your own setup.
|
- Before opening an issue, debug your problem by following [these instructions](https://flarum.org/docs/contributing/). Only open an issue if you are confident it is a bug with Flarum, not with your own setup.
|
||||||
|
|
||||||
- All issues should be reported on the [flarum/core](https://github.com/flarum/core/issues) repository. Issues pertaining to a specific extension should include the extension name in their title, e.g. `[Tags] Issue title`.
|
- All issues should be reported on the [flarum/core](https://github.com/flarum/core/issues) repository. Issues pertaining to a specific extension should include the extension name in their title, e.g. `[Tags] Issue title`.
|
||||||
|
|
||||||
|
@ -26,7 +26,7 @@ If you discover a security vulnerability within Flarum, please send an email to
|
||||||
|
|
||||||
- Do NOT checkin the JavaScript `dist` files in commits.
|
- Do NOT checkin the JavaScript `dist` files in commits.
|
||||||
|
|
||||||
- [Squash the commits](http://davidwalsh.name/squash-commits-git) if there are too many small ones.
|
- [Squash the commits](https://davidwalsh.name/squash-commits-git) if there are too many small ones.
|
||||||
|
|
||||||
- Follow the [code style](#code-style).
|
- Follow the [code style](#code-style).
|
||||||
|
|
||||||
|
@ -46,7 +46,7 @@ If you discover a security vulnerability within Flarum, please send an email to
|
||||||
$ composer update --prefer-source
|
$ composer update --prefer-source
|
||||||
```
|
```
|
||||||
|
|
||||||
Flarum's front-end code is written in ES6 and transpiled into JavaScript. The compiled JavaScript is only committed when we tag a release; during development you will need to do it yourself. To recompile the JavaScript you will need [Node.js](http://nodejs.org).
|
Flarum's front-end code is written in ES6 and transpiled into JavaScript. The compiled JavaScript is only committed when we tag a release; during development you will need to do it yourself. To recompile the JavaScript you will need [Node.js](https://nodejs.org/).
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
$ npm install -g gulp
|
$ npm install -g gulp
|
||||||
|
@ -64,7 +64,7 @@ See also the [First Read for Extension Developers](https://discuss.flarum.org/d/
|
||||||
|
|
||||||
## What to work on
|
## What to work on
|
||||||
|
|
||||||
Check out the [Roadmap](http://flarum.org/roadmap/) and [Milestones](https://github.com/flarum/core/milestones) for an overview of what needs to be done. See the [Good first issue](https://github.com/flarum/core/labels/Good%20first%20issue) label for a list of issues that should be relatively easy to get started with.
|
Check out the [Roadmap](https://flarum.org/roadmap/) and [Milestones](https://github.com/flarum/core/milestones) for an overview of what needs to be done. See the [Good first issue](https://github.com/flarum/core/labels/Good%20first%20issue) label for a list of issues that should be relatively easy to get started with.
|
||||||
|
|
||||||
## Contributor License Agreement
|
## Contributor License Agreement
|
||||||
|
|
||||||
|
|
|
@ -3,7 +3,7 @@
|
||||||
"description": "Delightfully simple forum software.",
|
"description": "Delightfully simple forum software.",
|
||||||
"type": "project",
|
"type": "project",
|
||||||
"keywords": ["forum", "discussion"],
|
"keywords": ["forum", "discussion"],
|
||||||
"homepage": "http://flarum.org",
|
"homepage": "https://flarum.org/",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"authors": [
|
"authors": [
|
||||||
{
|
{
|
||||||
|
@ -18,7 +18,7 @@
|
||||||
"support": {
|
"support": {
|
||||||
"issues": "https://github.com/flarum/core/issues",
|
"issues": "https://github.com/flarum/core/issues",
|
||||||
"source": "https://github.com/flarum/flarum",
|
"source": "https://github.com/flarum/flarum",
|
||||||
"docs": "http://flarum.org/docs"
|
"docs": "https://flarum.org/docs/"
|
||||||
},
|
},
|
||||||
"require": {
|
"require": {
|
||||||
"flarum/core": "^0.1.0",
|
"flarum/core": "^0.1.0",
|
||||||
|
|
14
readme.md
14
readme.md
|
@ -1,24 +1,24 @@
|
||||||

|

|
||||||
|
|
||||||
**[Flarum](http://flarum.org) is free, open-source forum software** built with PHP and [Mithril.js](http://mithril.js.org). It is:
|
**[Flarum](https://flarum.org/) is free, open-source forum software** built with PHP and [Mithril.js](https://mithril.js.org/). It is:
|
||||||
|
|
||||||
* **Simple**, with a responsive UI that is optimized for touch devices
|
* **Simple**, with a responsive UI that is optimized for touch devices
|
||||||
* **Fast**, with a total JS payload size of ~130 KB gzipped
|
* **Fast**, with a total JS payload size of ~130 KB gzipped
|
||||||
* **Extensible**, so you can tailor it to your use-case
|
* **Extensible**, so you can tailor it to your use-case
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
> **Flarum is currently in beta and should not be used in production.** It is being developed openly on GitHub. Check out the [Roadmap](http://flarum.org/roadmap) to follow along with our progress.
|
> **Flarum is currently in beta and should not be used in production.** It is being developed openly on GitHub. Check out the [Roadmap](https://flarum.org/roadmap/) to follow along with our progress.
|
||||||
|
|
||||||
You must have SSH access to a server with **PHP 5.5+** and **MySQL 5.5+**, and install [Composer](https://getcomposer.org).
|
You must have SSH access to a server with **PHP 5.5+** and **MySQL 5.5+**, and install [Composer](https://getcomposer.org/).
|
||||||
|
|
||||||
```
|
```
|
||||||
composer create-project flarum/flarum . --stability=beta
|
composer create-project flarum/flarum . --stability=beta
|
||||||
```
|
```
|
||||||
|
|
||||||
Read the [Installation Guide](http://flarum.org/docs/installation) for more information.
|
Read the [Installation Guide](https://flarum.org/docs/installation/) for more information.
|
||||||
|
|
||||||
## Development
|
## Development
|
||||||
|
|
||||||
|
@ -27,7 +27,7 @@ Its dependencies, such as [flarum/core](https://github.com/flarum/core) (where m
|
||||||
|
|
||||||
## Support
|
## Support
|
||||||
|
|
||||||
Refer to the [FAQ](http://flarum.org/docs/faq), [Documentation](http://flarum.org/docs), and ask questions on the [Community Forum](http://discuss.flarum.org) or [Discord Chat](http://flarum.org/discord).
|
Refer to the [FAQ](https://flarum.org/docs/faq/), [Documentation](https://flarum.org/docs/), and ask questions on the [Community Forum](https://discuss.flarum.org/) or [Discord Chat](https://flarum.org/discord/).
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue