diff --git a/README.md b/README.md new file mode 100644 index 000000000..1090463fd --- /dev/null +++ b/README.md @@ -0,0 +1,167 @@ +
+ +![GitHub tag (latest SemVer)](https://img.shields.io/github/tag/LemmyNet/lemmy.svg) +[![Build Status](https://cloud.drone.io/api/badges/LemmyNet/lemmy/status.svg)](https://cloud.drone.io/LemmyNet/lemmy/) +[![GitHub issues](https://img.shields.io/github/issues-raw/LemmyNet/lemmy.svg)](https://github.com/LemmyNet/lemmy/issues) +[![Docker Pulls](https://img.shields.io/docker/pulls/dessalines/lemmy.svg)](https://cloud.docker.com/repository/docker/dessalines/lemmy/) +[![Translation status](http://weblate.yerbamate.ml/widgets/lemmy/-/lemmy/svg-badge.svg)](http://weblate.yerbamate.ml/engage/lemmy/) +[![License](https://img.shields.io/github/license/LemmyNet/lemmy.svg)](LICENSE) +![GitHub stars](https://img.shields.io/github/stars/LemmyNet/lemmy?style=social) +[![Awesome Humane Tech](https://raw.githubusercontent.com/humanetech-community/awesome-humane-tech/main/humane-tech-badge.svg?sanitize=true)](https://github.com/humanetech-community/awesome-humane-tech) +
+ +

+ English | + Español | + Русский +

+ +

+ + + +

Lemmy

+

+ A link aggregator / Reddit clone for the fediverse. +
+
+ Join Lemmy + · + Documentation + · + Report Bug + · + Request Feature + · + Releases + · + Code of Conduct +

+

+ +## About The Project + +Desktop|Mobile +---|--- +![desktop](https://raw.githubusercontent.com/LemmyNet/joinlemmy-site/main/src/assets/images/main_img.webp)|![mobile](https://raw.githubusercontent.com/LemmyNet/joinlemmy-site/main/src/assets/images/mobile_pic.webp) + +[Lemmy](https://github.com/LemmyNet/lemmy) is similar to sites like [Reddit](https://reddit.com), [Lobste.rs](https://lobste.rs), or [Hacker News](https://news.ycombinator.com/): you subscribe to forums you're interested in, post links and discussions, then vote, and comment on them. Behind the scenes, it is very different; anyone can easily run a server, and all these servers are federated (think email), and connected to the same universe, called the [Fediverse](https://en.wikipedia.org/wiki/Fediverse). + +For a link aggregator, this means a user registered on one server can subscribe to forums on any other server, and can have discussions with users registered elsewhere. + +The overall goal is to create an easily self-hostable, decentralized alternative to Reddit and other link aggregators, outside of their corporate control and meddling. + +Each Lemmy server can set its own moderation policy; appointing site-wide admins, and community moderators to keep out the trolls, and foster a healthy, non-toxic environment where all can feel comfortable contributing. + +*Note: The WebSocket and HTTP APIs are currently unstable* + +### Why's it called Lemmy? + +- Lead singer from [Motörhead](https://invidio.us/watch?v=pWB5JZRGl0U). +- The old school [video game](). +- The [Koopa from Super Mario](https://www.mariowiki.com/Lemmy_Koopa). +- The [furry rodents](http://sunchild.fpwc.org/lemming-the-little-giant-of-the-north/). + +### Built With + +- [Rust](https://www.rust-lang.org) +- [Actix](https://actix.rs/) +- [Diesel](http://diesel.rs/) +- [Inferno](https://infernojs.org) +- [Typescript](https://www.typescriptlang.org/) + +## Features + +- Open source, [AGPL License](/LICENSE). +- Self hostable, easy to deploy. + - Comes with [Docker](https://join.lemmy.ml/docs/en/administration/install_docker.html) and [Ansible](https://join.lemmy.ml/docs/en/administration/install_ansible.html). +- Clean, mobile-friendly interface. + - Only a minimum of a username and password is required to sign up! + - User avatar support. + - Live-updating Comment threads. + - Full vote scores `(+/-)` like old Reddit. + - Themes, including light, dark, and solarized. + - Emojis with autocomplete support. Start typing `:` + - User tagging using `@`, Community tagging using `!`. + - Integrated image uploading in both posts and comments. + - A post can consist of a title and any combination of self text, a URL, or nothing else. + - Notifications, on comment replies and when you're tagged. + - Notifications can be sent via email. + - Private messaging support. + - i18n / internationalization support. + - RSS / Atom feeds for `All`, `Subscribed`, `Inbox`, `User`, and `Community`. +- Cross-posting support. + - A *similar post search* when creating new posts. Great for question / answer communities. +- Moderation abilities. + - Public Moderation Logs. + - Can sticky posts to the top of communities. + - Both site admins, and community moderators, who can appoint other moderators. + - Can lock, remove, and restore posts and comments. + - Can ban and unban users from communities and the site. + - Can transfer site and communities to others. +- Can fully erase your data, replacing all posts and comments. +- NSFW post / community support. +- OEmbed support via Iframely. +- High performance. + - Server is written in rust. + - Front end is `~80kB` gzipped. + - Supports arm64 / Raspberry Pi. + +## Installation + +- [Docker](https://join.lemmy.ml/docs/en/administration/install_docker.html) +- [Ansible](https://join.lemmy.ml/docs/en/administration/install_ansible.html) + +## Lemmy Projects + +### Apps + +- [lemmy-ui - The official web app for lemmy](https://github.com/LemmyNet/lemmy-ui) +- [Lemmur - A mobile client for Lemmy (Android, Linux, Windows)](https://github.com/krawieck/lemmur) +- [Remmel - A native iOS app](https://github.com/uuttff8/Lemmy-iOS) + +### Libraries + +- [lemmy-js-client](https://github.com/LemmyNet/lemmy-js-client) +- [Kotlin API ( under development )](https://github.com/eiknat/lemmy-client) +- [Dart API client ( under development )](https://github.com/krawieck/lemmy_api_client) + +## Support / Donate + +Lemmy is free, open-source software, meaning no advertising, monetizing, or venture capital, ever. Your donations directly support full-time development of the project. + +- [Support on Liberapay](https://liberapay.com/Lemmy). +- [Support on Patreon](https://www.patreon.com/dessalines). +- [Support on OpenCollective](https://opencollective.com/lemmy). +- [List of Sponsors](https://join.lemmy.ml/sponsors). + +### Crypto + +- bitcoin: `1Hefs7miXS5ff5Ck5xvmjKjXf5242KzRtK` +- ethereum: `0x400c96c96acbC6E7B3B43B1dc1BB446540a88A01` +- monero: `41taVyY6e1xApqKyMVDRVxJ76sPkfZhALLTjRvVKpaAh2pBd4wv9RgYj1tSPrx8wc6iE1uWUfjtQdTmTy2FGMeChGVKPQuV` + +## Contributing + +- [Contributing instructions](https://join.lemmy.ml/docs/en/contributing/contributing.html) +- [Docker Development](https://join.lemmy.ml/docs/en/contributing/docker_development.html) +- [Local Development](https://join.lemmy.ml/docs/en/contributing/local_development.html) + +### Translations + +If you want to help with translating, take a look at [Weblate](https://weblate.yerbamate.ml/projects/lemmy/). You can also help by [translating the documentation](https://github.com/LemmyNet/lemmy-docs#adding-a-new-language). + +## Contact + +- [Mastodon](https://mastodon.social/@LemmyDev) +- [Matrix](https://matrix.to/#/#lemmy:matrix.org) + +## Code Mirrors + +- [GitHub](https://github.com/LemmyNet/lemmy) +- [Gitea](https://yerbamate.ml/LemmyNet/lemmy) +- [Codeberg](https://codeberg.org/LemmyNet/lemmy) + +## Credits + +Logo made by Andy Cuccaro (@andycuccaro) under the CC-BY-SA 4.0 license. diff --git a/readmes/README.es.md b/readmes/README.es.md index 7b6371470..329deb1cc 100644 --- a/readmes/README.es.md +++ b/readmes/README.es.md @@ -12,7 +12,8 @@

English | - Español + Español | + Русский

diff --git a/README.ru.md b/readmes/README.ru.md similarity index 99% rename from README.ru.md rename to readmes/README.ru.md index a8271adaf..34f6dbcd3 100644 --- a/README.ru.md +++ b/readmes/README.ru.md @@ -11,8 +11,9 @@

- English | - Русский + English | + Español | + Русский