github/hedgedoc
1
0
Fork 0
mirror of https://github.com/hedgedoc/hedgedoc.git synced 2024-11-21 17:26:29 -05:00
Code Issues Projects Releases Packages Wiki Activity

Add clear 'getting started' instructions to README

Browse source 
Signed-off-by: David Mehren <git@herrmehren.de>
This commit is contained in:
David Mehren 2021-04-16 19:22:50 +02:00
parent c1d706b350
commit 9f293b4747
No known key found for this signature in database
GPG key ID: 185982BA4C42B7C3
1 changed files with 15 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
README.md
View file

@ -4,7 +4,7 @@ SPDX-FileCopyrightText: 2021 The HedgeDoc developers (see AUTHORS file)
SPDX-License-Identifier: CC-BY-SA-4.0
-->
HedgeDoc 2
HedgeDoc
===
[![#HedgeDoc on matrix.org][matrix.org-image]][matrix.org-url]
@ -16,25 +16,28 @@ HedgeDoc 2
![Nest.JS CI][nestjs-workflow-badge]
[![codecov][codecov-badge]][codecov-url]
HedgeDoc lets you create real-time collaborative markdown notes. Have a look at [our website](https://hedgedoc.org) for
more details.
HedgeDoc lets you create real-time collaborative markdown notes.
⚠️⚠️⚠️ **Important:** We are currently working on HedgeDoc 2, a complete rewrite of HedgeDoc. Please note the following:
## Getting Started
- ℹ️ Read all about HedgeDoc and the history of the project on [our website](https://hedgedoc.org)
- 🧪 Try out HedgeDoc with the [demo instance][hedgedoc-demo]. Check out the [features page][hedgedoc-demo-features]!
- 💽 Install HedgeDoc yourself using the [install guide](https://docs.hedgedoc.org/setup/getting-started/)
- ❓ Questions? Join our [Matrix chat][matrix.org-url] or the [community forums][hedgedoc-community]
- 💬 Stay up to date by subscribing to the [release feed][github-release-feed]
- This branch contains the latest development code and does not implement all features yet. **If you are looking for the
1.x source code, have a look at the `master` branch.**
## State of the project
We are currently working on HedgeDoc 2, a complete rewrite of HedgeDoc. Please note the following:
- This branch contains the latest development code and does not implement all features yet.
**If you are looking for the 1.x source code, have a look at the [master branch](https://github.com/hedgedoc/hedgedoc/tree/master).**
- HedgeDoc 2 will be split in two components: the backend (this repo) and the frontend in
the [react-client repo](https://github.com/hedgedoc/react-client).
- The 1.x release is maintenance-only. We do not accept feature requests or PRs for this release anymore and may choose
to close non-critical bug reports, if the bug will be non-existent in 2.0.
## Community and Contributions
To stay up to date with our work or get support it's recommended to join our
[Matrix channel][matrix.org-url], stop by our [community forums][hedgedoc-community]
or subscribe to the [release feed][github-release-feed]. We also engage in
regular [community calls][hedgedoc-community-calls] ([RSS](https://community.codimd.org/t/codimd-community-call/19.rss))
which you are very welcome to join.
## Contributions
We welcome contributions!
Have a look at our [contribution docs](CONTRIBUTING.md) to find out how you can help. If you want to contribute to