MirrorHub
/
construct
mirror of https://github.com/matrix-construct/construct
0
0
Fork 0
Code Issues Releases Wiki Activity
construct/README.md

48 lines
2.8 KiB
Markdown
Raw Permalink Normal View History

Move sections from include README to main README; various updates.
2017-11-30 19:30:19 +01:00
# This — is The **Construct**
move README to markdown.
2015-02-25 03:32:08 +01:00
Update README; link to wiki for docker grid. [ci skip]
2023-03-24 07:35:08 +01:00
#### FEDERATED MESSAGING SERVER
README: Add project description subtitle. [ci skip]
2022-07-27 22:43:34 +02:00
README: Add more dockers and badges.
2022-07-26 03:23:00 +02:00
[![Chat in #construct:zemos.net](https://img.shields.io/matrix/construct:zemos.net.svg?label=Chat%20in%20%23construct%3Azemos.net&logo=matrix&server_fqdn=matrix.org&style=for-the-badge&color=5965AF)](https://matrix.to/#/#construct:zemos.net) [![](https://img.shields.io/badge/License-BSD-5965AF.svg?label=%20license&style=for-the-badge)]()
Simplify README. [ci skip]
2020-04-24 01:09:47 +02:00
Update README; link to wiki for docker grid. [ci skip]
2023-03-24 07:35:08 +01:00
### 🚚 GET CONSTRUCT
Update README.md
2017-08-18 00:33:22 +02:00
README: Add badges for dockerhub and appveyor build. [ci skip]
2022-07-21 05:33:11 +02:00
- `git clone https://github.com/matrix-construct/construct`
Update README; setup instructions.
2018-09-04 07:03:32 +02:00
README: Add more dockers and badges.
2022-07-26 03:23:00 +02:00
[![](https://img.shields.io/github/repo-size/matrix-construct/construct.svg?logo=GitHub&style=flat-square&color=5965AF)](https://github.com/matrix-construct/construct)
[![](https://img.shields.io/github/languages/code-size/matrix-construct/construct.svg?logo=GitHub&style=flat-square&color=5965AF)](https://github.com/matrix-construct/construct)
[![](https://img.shields.io/github/directory-file-count/matrix-construct/construct.svg?type=dir&label=directories&logo=GitHub&style=flat-square&color=5965AF)](https://github.com/matrix-construct/construct)
[![](https://img.shields.io/github/directory-file-count/matrix-construct/construct.svg?type=file&label=files&logo=GitHub&style=flat-square&color=5965AF)](https://github.com/matrix-construct/construct)
Update README; link to wiki for docker grid. [ci skip]
2023-03-24 07:35:08 +01:00
- 📦 [**DISTRIBUTION PACKAGES**](https://github.com/matrix-construct/construct/wiki/PACKAGE)
- 🐋 [**DOCKER IMAGES**](https://github.com/matrix-construct/construct/wiki/DOCKER)
README: Add more dockers and badges.
2022-07-26 03:23:00 +02:00
### 🗒️ INSTRUCTIONS
README: Add blerb on -pitrecdb.
2019-04-17 01:01:28 +02:00
Update README; link to wiki for docker grid. [ci skip]
2023-03-24 07:35:08 +01:00
1. 🏗️ [**BUILD**](https://github.com/matrix-construct/construct/wiki/BUILD) to compile Construct from source.
README: Add badges for dockerhub and appveyor build. [ci skip]
2022-07-21 05:33:11 +02:00
Update README; link to wiki for docker grid. [ci skip]
2023-03-24 07:35:08 +01:00
2. 🪛 [**SETUP**](https://github.com/matrix-construct/construct/wiki/SETUP) to run Construct for the first time.
doc: Add preliminary TUNING guide. [ci skip]
2020-01-02 20:03:14 +01:00
Update README; link to wiki for docker grid. [ci skip]
2023-03-24 07:35:08 +01:00
3. ⚡ [**TUNING**](https://github.com/matrix-construct/construct/wiki/TUNING) to optimize Construct for your deployment.
README: Add blerb on -pitrecdb.
2019-04-17 01:01:28 +02:00
README: Add project description subtitle. [ci skip]
2022-07-27 22:43:34 +02:00
- 🙋 [TROUBLESHOOTING](https://github.com/matrix-construct/construct/wiki/Troubleshooting-problems) guide for solutions to possible problems.
README: Add blerb on -pitrecdb.
2019-04-17 01:01:28 +02:00
README: Add project description subtitle. [ci skip]
2022-07-27 22:43:34 +02:00
- ❓ [FREQUENTLY ASKED QUESTIONS](https://github.com/matrix-construct/construct/wiki/FAQ) for answers to the most common perplexities.
doc: Start an FAQ.
2020-04-29 04:59:58 +02:00
README: Add more dockers and badges.
2022-07-26 03:23:00 +02:00
>🛑 Operating a Construct server which is open to public user registration is unsafe. Local users may be able to exceed resource limitations and deny service to other users.
README: Move warning out of developers section. [ci skip]
2022-07-21 20:20:24 +02:00
README: Add more dockers and badges.
2022-07-26 03:23:00 +02:00
## 👷‍♀️ DEVELOPERS
move README to markdown.
2015-02-25 03:32:08 +01:00
README: Add more dockers and badges.
2022-07-26 03:23:00 +02:00
[![](https://img.shields.io/badge/PRs-welcome-8891CD.svg?label=contributions)]() [![](https://ci.appveyor.com/api/projects/status/qck2bpb57704jmtf?svg=true&style=for-the-badge)]()
README: Add badges for dockerhub and appveyor build. [ci skip]
2022-07-21 05:33:11 +02:00
README: Add more dockers and badges.
2022-07-26 03:23:00 +02:00
##### 📚 DOCUMENTATION
doc: Improve architecture; add to top readme. [skip ci]
2019-09-16 19:01:43 +02:00
README: Add more dockers and badges.
2022-07-26 03:23:00 +02:00
Generate doxygen using `doxygen ./Doxyfile` the target directory is `doc/html`.
Browse to `doc/html/index.html`.
build: remove more autotools detritus
2016-03-06 00:49:13 +01:00
README: Add more dockers and badges.
2022-07-26 03:23:00 +02:00
##### 🛣️ DEPLOYMENT ROADMAP
README: Tweak heading style consistency; roadmap related. [skip ci]
2019-09-19 19:02:57 +02:00
README: Clarify deployment scale description based on reported confusion.
2020-04-05 22:41:44 +02:00
- [x] **Personal**: Dozens of users. Few default restrictions; higher log output.
Update README.
2018-04-21 12:24:50 +02:00
- [ ] **Company**: Hundreds of users. Moderate default restrictions.
- [ ] **Public**: Thousands of users. Untrusting configuration defaults.