Add emoji to README.md

(controversial, though it does give much better readability)
This commit is contained in:
Lamparter 2024-09-28 15:59:41 +01:00 committed by Lamparter
parent 50ba96013c
commit fbfe79b13c

View file

@ -15,7 +15,7 @@
Mastodon is a **free, open-source social network server** based on ActivityPub where users can follow friends and discover new ones. On Mastodon, users can publish anything they want: links, pictures, text, and video. All Mastodon servers are interoperable as a federated network (users on one server can seamlessly communicate with users from another one, including non-Mastodon software that implements ActivityPub!)
## Navigation
## 🐘 Navigation
- [Project homepage 🐘](https://joinmastodon.org)
- [Support the development via Patreon][patreon]
@ -29,7 +29,7 @@ Mastodon is a **free, open-source social network server** based on ActivityPub w
[patreon]: https://www.patreon.com/mastodon
## Features
## Features
<img src="/app/javascript/images/elephant_ui_working.svg?raw=true" align="right" width="30%" />
@ -43,15 +43,15 @@ Mastodon is a **free, open-source social network server** based on ActivityPub w
#### **🔶 OAuth2 and a straightforward REST API** - Mastodon acts as an OAuth2 provider, so 3rd party apps can use the REST and Streaming APIs. This results in a rich app ecosystem with a lot of choices!
## Deployment
## 📦 Deployment
### Tech stack
### 🗃️ Tech stack
- **Ruby on Rails** powers the REST API and other web pages
- **React.js** and **Redux** are used for the dynamic parts of the interface
- **Node.js** powers the streaming API
### Requirements
### ⬇️ Requirements
- **PostgreSQL** 12+
- **Redis** 4+
@ -60,9 +60,9 @@ Mastodon is a **free, open-source social network server** based on ActivityPub w
The repository includes deployment configurations for **Docker and docker-compose** as well as specific platforms like **Heroku**, and **Scalingo**. For Helm charts, reference the [mastodon/chart repository](https://github.com/mastodon/chart). The [**standalone** installation guide](https://docs.joinmastodon.org/admin/install/) is available in the documentation.
## Development
## 🛠️ Development
### Vagrant
### 🔤 Vagrant
A **Vagrant** configuration is included for development purposes. To use it, complete the following steps:
@ -72,7 +72,7 @@ A **Vagrant** configuration is included for development purposes. To use it, com
- Run `vagrant ssh -c "cd /vagrant && bin/dev"`
- Open `http://mastodon.local` in your browser
### macOS
### 💻 macOS
To set up **macOS** for native development, complete the following steps:
@ -85,7 +85,7 @@ libidn nvm` to install the required project dependencies
- Finally, run the `bin/dev` script which will launch services via `overmind`
(if installed) or `foreman`
### Docker
### 🐋 Docker
For production hosting and deployment with **Docker**, use the `Dockerfile` and
`docker-compose.yml` in the project root directory.
@ -98,14 +98,14 @@ docker compose -f .devcontainer/compose.yaml exec app bin/setup
docker compose -f .devcontainer/compose.yaml exec app bin/dev
```
### Dev Containers
### 🫙 Dev Containers
Within IDEs that support the [Development Containers] specification, start the
"Mastodon on local machine" container from the editor. The necessary `docker
compose` commands to build and setup the container should run automatically. For
**Visual Studio Code** this requires installing the [Dev Container extension].
### GitHub Codespaces
### 😺 GitHub Codespaces
[GitHub Codespaces] provides a web-based version of VS Code and a cloud hosted
development environment configured with the software needed for this project.
@ -118,7 +118,7 @@ development environment configured with the software needed for this project.
- Wait for an _Open in Browser_ prompt. This will open Mastodon
- On the _Ports_ tab "stream" setting change _Port visibility_ → _Public_
## Contributing
## 🙋 Contributing
Mastodon is **free, open-source software** licensed under **AGPLv3**.
@ -126,7 +126,7 @@ You can open issues for bugs you've found or features you think are missing. You
**IRC channel**: #mastodon on [`irc.libera.chat`](https://libera.chat)
## License
## ⚖️ License
Copyright (C) 2016-2024 Eugen Rochko (+ [`mastodon authors`](AUTHORS.md))