diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..1d0ebc06 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,37 @@ +Contributing to Typecho +======================= + +Thanks for considering contributing to Typecho! There are many ways to contribute to Typecho, and we appreciate all of them. + +## Reporting Bugs + +If you find a bug in the source code, you can help us by [submitting an issue](https://github.com/typecho/typecho/issues) +to our [GitHub Repository](https://github.com/typecho/typecho). Even better, you can submit a Pull Request with a fix. + +## Contributing Code + +If you would like to contribute code to Typecho, please read the following guidelines: + +* [Code of Conduct](CODE_OF_CONDUCT.md) +* [Contributing Guide](CONTRIBUTING.md) +* [Coding Style Guide](CODING_STYLE.md) + +## Translations + +Please see [TRANSLATION](https://github.com/typecho/languages) for details. + +## Plugin Development + +Please see [Plugin Development](http://docs.typecho.org/plugins) for details. + +## Theme Development + +Please see [Theme Development](http://docs.typecho.org/themes) for details. + +## Community + +* [Telegram Channel](https://t.me/typechodev) +* [Homepage](http://typecho.org/) +* [Documents](http://docs.typecho.org/) +* [Community](http://forum.typecho.org/) +* [Download](http://typecho.org/download) \ No newline at end of file diff --git a/README.md b/README.md index 570190b2..648508a5 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,30 @@ Typecho Blogging Platform ========================= -Typecho is a PHP Blogging Platform. Simple and Powerful. +Typecho is a PHP-based blog software and is designed to be the most powerful blog engine in the world. +Typecho is released under the GNU General Public License 2.0. -#### Telegram Channel -https://t.me/typechodev +## Main Features -#### Homepage -http://typecho.org/ +* Multiple databases support (MySQL, SQLite, PostgreSQL) +* Markdown Support +* Plugin Support +* Theme Support +* Custom Fields +* Custom Pages -#### Documents -http://docs.typecho.org/ +## Requirements -#### Community -http://forum.typecho.org/ +* PHP 7.2.0 or higher +* Database (MySQL, SQLite, PostgreSQL) + * MySQL 5.5.3 or higher + * SQLite 3.7.11 or higher + * PostgreSQL 9.1 or higher -#### Download -http://typecho.org/download +## Screenshots + +![Typecho](https://typecho.org/usr/themes/bluecode/img/screenshot/st1.png) + +## Contributing + +Please see [CONTRIBUTING](CONTRIBUTING.md) for details.