docs: update README [skip ci]

README.md

@@ -3,33 +3,82 @@
 This is a monorepo for the Revolt backend.
 
 | Crate              | Path                                               | Description                       |
-| ---------------- | ---------------------------------------------- | ------------------------------------ |
+| ------------------ | -------------------------------------------------- | --------------------------------- |
+| `core/config`      | [crates/core/config](crates/core/config)           | Core: Configuration               |
+| `core/database`    | [crates/core/database](crates/core/database)       | Core: Database Implementation     |
+| `core/models`      | [crates/core/models](crates/core/models)           | Core: API Models                  |
+| `core/permissions` | [crates/core/permissions](crates/core/permissions) | Core: Permission Logic            |
+| `core/presence`    | [crates/core/presence](crates/core/presence)       | Core: User Presence               |
+| `core/result`      | [crates/core/result](crates/core/result)           | Core: Result and Error types      |
 | `delta`            | [crates/delta](crates/delta)                       | REST API server                   |
 | `bonfire`          | [crates/bonfire](crates/bonfire)                   | WebSocket events server           |
-| `quark`          | [crates/quark](crates/quark)                   | Models and logic                     |
+| `quark`            | [crates/quark](crates/quark)                       | Models and logic (**DEPRECATED**) |
-<!--| `revcord/api`    | [crates/revcord/api](crates/revcord/api)       | Discord REST translation layer       |
-| `revcord/ws`     | [crates/revcord/ws](crates/revcord/ws)         | Discord gateway translation layer    |
-| `revcord/models` | [crates/revcord/models](crates/revcord/models) | Discord models and quark translation |-->
 
 Note: `january`, `autumn`, and `vortex` are yet to be moved into this monorepo.
 
-## Resources
-
-### Revolt
-
-- [Revolt Project Board](https://github.com/revoltchat/revolt/discussions) (Submit feature requests here)
-- [Revolt Testers Server](https://app.revolt.chat/invite/Testers)
-- [Contribution Guide](https://developers.revolt.chat/contributing)
-
 ## Minimum Supported Rust Version
 
 Rust 1.70 or higher.
 
-## Contributing
+## Development Guide
 
-The contribution guide is located at [developers.revolt.chat/contributing](https://developers.revolt.chat/contributing).
+Before getting started, you'll want to install:
-Please note that a pull request should only take care of one issue so that we can review it quickly.
+
+- Rust toolchain (rustup recommended)
+- Docker
+- Git
+- mold (optional, faster compilation)
+
+> A **default.nix** is available for Nix users!
+> Just run `nix-shell` and continue.
+
+Now you can clone and build the project:
+
+```bash
+git clone https://github.com/revoltchat/backend revolt-backend
+cd revolt-backend
+cargo build
+```
+
+If you want to run the API and event servers:
+
+```bash
+# create environment file (will be deprecated in future)
+cp .env.example .env
+# (optionally) copy the default configuration file
+cp crates/core/config/Revolt.toml Revolt.toml
+# configure as necessary...
+
+# start other necessary services
+docker compose up -d
+
+# run the API server
+cargo run --bin revolt-delta
+# run the events server
+cargo run --bin revolt-bonfire
+
+# hint:
+# mold -run <cargo build, cargo run, etc...>
+```
+
+You can start a web client by doing the following:
+
+```bash
+# if you do not have yarn yet and have a modern Node.js:
+corepack enable
+
+# clone the web client and run it:
+git clone --recursive https://github.com/revoltchat/revite
+cd revite
+yarn
+yarn build:deps
+yarn dev --port 3001
+```
+
+Then go to https://local.revolt.chat:3001
 
 ## License
 
-The Revolt backend is generally licensed under the [GNU Affero General Public License v3.0](https://github.com/revoltchat/backend/blob/master/LICENSE). Please check individual crates for further license information.
+The Revolt backend is generally licensed under the [GNU Affero General Public License v3.0](https://github.com/revoltchat/backend/blob/master/LICENSE).
+
+**Individual crates may supply their own licenses!**