64 lines
2.2 KiB
Markdown
64 lines
2.2 KiB
Markdown
# Morpheus
|
|
|
|
Privacy-centric social network for Russian-speaking users, built on the
|
|
[Nostr](https://nostr.com/) protocol.
|
|
|
|
> "Everyone knows your name. Nobody reads your messages."
|
|
|
|
## Sketches
|
|
|
|
| Feed | Groups | Chat |
|
|
| :---: | :---: | :---: |
|
|
|  |  |  |
|
|
|
|
## Prerequisites
|
|
|
|
| Tool | Purpose | Install |
|
|
| --- | --- | --- |
|
|
| [just](https://github.com/casey/just) | Command runner | `brew install just` / `cargo install just` |
|
|
| [markdownlint-cli2](https://github.com/DavidAnson/markdownlint-cli2) | Markdown linter | `npm install -g markdownlint-cli2` |
|
|
| [lefthook](https://github.com/evilmartians/lefthook) | Git hooks manager | `gem install lefthook` / `brew install lefthook` |
|
|
|
|
After cloning, install git hooks:
|
|
|
|
```sh
|
|
lefthook install
|
|
```
|
|
|
|
## Just commands
|
|
|
|
[just](https://github.com/casey/just) is a command runner (like `make`, but
|
|
simpler). Run `just --list` to see all available recipes.
|
|
|
|
```sh
|
|
just lint-md # Lint all Markdown files
|
|
```
|
|
|
|
## Markdown linting
|
|
|
|
All `.md` files are linted with
|
|
[markdownlint-cli2](https://github.com/DavidAnson/markdownlint-cli2) to keep
|
|
documentation consistent and well-formatted. Configuration lives in
|
|
`.markdownlint-cli2.yaml`.
|
|
|
|
The lint runs automatically on every commit via lefthook (see `lefthook.yml`).
|
|
To run it manually:
|
|
|
|
```sh
|
|
just lint-md
|
|
# or directly:
|
|
markdownlint-cli2 "**/*.md"
|
|
```
|
|
|
|
## Documentation
|
|
|
|
All docs are maintained in English and Russian (keep both in sync).
|
|
|
|
| Document | EN | RU |
|
|
| --- | --- | --- |
|
|
| Philosophy | [docs/philosophy.md](docs/philosophy.md) | [docs/ru/philosophy.md](docs/ru/philosophy.md) |
|
|
| Monetization | [docs/monetization.md](docs/monetization.md) | [docs/ru/monetization.md](docs/ru/monetization.md) |
|
|
| Design system | [docs/design-system.md](docs/design-system.md) | [docs/ru/design-system.md](docs/ru/design-system.md) |
|
|
| Threat model | [docs/threat-model-and-workarounds.md](docs/threat-model-and-workarounds.md) | [docs/ru/threat-model-and-workarounds.md](docs/ru/threat-model-and-workarounds.md) |
|
|
| Web of trust | [docs/web-of-trust.md](docs/web-of-trust.md) | [docs/ru/web-of-trust.md](docs/ru/web-of-trust.md) |
|