Parcourir la source

Update README.md

John Guan il y a 3 ans
Parent
commit
2796c37bf6
1 fichiers modifiés avec 167 ajouts et 60 suppressions
  1. 167 60
      README.md

+ 167 - 60
README.md

@@ -1,39 +1,115 @@
-<!--
- * @Author: LinkLeong link@icewhale.com
- * @Date: 2022-05-13 18:15:56
- * @LastEditors: LinkLeong
- * @LastEditTime: 2022-07-08 14:10:58
- * @FilePath: /CasaOS/README.md
- * @Description: 
- * @Website: https://www.casaos.io
- * Copyright (c) 2022 by icewhale, All Rights Reserved. 
--->
-# CasaOS - A simple, easy-to-use, elegant open-source Home Cloud system.
+# CasaOS - Your Home Cloud OS
+
+<!-- Readme i18n links -->
+<!-- > English | [中文](#) | [Français](#) -->
+
+<p align="center">
+    <!-- CasaOS Banner -->
+    <picture>
+        <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/IceWhaleTech/logo/main/casaos/casaos_bannner_dark_night_800px.png">
+        <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/IceWhaleTech/logo/main/casaos/casaos_banner_twilight_blue_800px.png">
+        <img alt="CasaOS" src="https://raw.githubusercontent.com/IceWhaleTech/logo/main/casaos/casaos_banner_twilight_blue_800px.png">
+    </picture>
+    <br/>
+    <i>Connect with the community developing HOME CLOUD, creating self-sovereign, and defining the future of the distributed cloud.</i>
+    <br/>
+    <br/>
+    <!-- CasaOS Badges -->
+    <a href="https://github.com/IceWhaleTech/CasaOS" target="_blank">
+        <img alt="CasaOS Version" src="https://img.shields.io/github/v/release/IceWhaleTech/CasaOS?color=162453&style=flat-square&label=CasaOS" />
+    </a>
+    <a href="https://github.com/IceWhaleTech/CasaOS/blob/main/LICENSE" target="_blank">
+        <img alt="CasaOS License" src="https://img.shields.io/github/license/IceWhaleTech/CasaOS?color=162453&style=flat-square&label=License" />
+    </a>
+    <a href="https://github.com/IceWhaleTech/CasaOS/pulls" target="_blank">
+        <img alt="CasaOS Pull Requests" src="https://img.shields.io/github/issues-pr/IceWhaleTech/CasaOS?color=162453&style=flat-square&label=PRs" />
+    </a>
+    <a href="https://github.com/IceWhaleTech/CasaOS/issues" target="_blank">
+        <img alt="CasaOS Issues" src="https://img.shields.io/github/issues/IceWhaleTech/CasaOS?color=162453&style=flat-square&label=Issues" />
+    </a>
+    <a href="https://github.com/IceWhaleTech/CasaOS/stargazers" target="_blank">
+        <img alt="CasaOS Stargazers" src="https://img.shields.io/github/stars/IceWhaleTech/CasaOS?color=162453&style=flat-square&label=Stars" />
+    </a>
+    <!-- <a href="https://github.com/IceWhaleTech/CasaOS/releases" target="_blank">
+    <img alt="CasaOS Downloads" src="https://img.shields.io/github/downloads/IceWhaleTech/CasaOS/total?color=162453&style=flat-square" />
+    </a> -->
+    <br/>
+    <!-- CasaOS Community -->
+    <a href="https://discord.gg/knqAbbBbeX" target="_blank">
+        <img alt="IceWhale Discord" src="https://img.shields.io/discord/884667213326463016?color=162453&style=flat-square&label=Discord&logo=discord&logoColor=fff" />
+    </a>
+    <a href="https://github.com/IceWhaleTech/CasaOS/discussions" target="_blank">
+        <img alt="CasaOS GitHub Discussions" src="https://img.shields.io/github/discussions/IceWhaleTech/CasaOS?color=162453&style=flat-square&label=Discussions&logo=github" />
+    </a>
+    <br/>
+    <!-- CasaOS Links -->
+    <a href="https://www.casaos.io" target="_blank">Website</a> |
+    <a href="http://demo.casaos.io" target="_blank">Demo</a> |
+    <a href="https://github.com/IceWhaleTech/CasaOS" target="_blank">GitHub</a>
+    <br/>
+    <br/>
+    <!-- CasaOS Snapshots -->
+    <picture style="filter: drop-shadow(0px 2px 4px black);">
+        <source media="(prefers-color-scheme: dark)" srcset="snapshot-dark.jpg">
+        <source media="(prefers-color-scheme: light)" srcset="snapshot-light.jpg">
+        <img alt="CasaOS Snapshot" src="snapshot-light.jpg">
+    </picture>
+</p>
+
+## Why do we need Home Cloud?
+
+Think about it seriously. Is control of our data, smart devices and digital assets now only in the hands of some big company?
+
+- Is your photo album saved in their cloud service?
+- Do your thermostats, monitors, lamps need to be used through their cloud services?
+- Do your personal documents, memos, contacts, passwords, etc. reside in their cloud storage services?
+- Are you just going to have to accept their decisions when they decide to change prices, review content or even discontinue services?
+
+It sounds ridiculous, doesn't it? We are losing control of our own data!
+
+Our ideal home cloud is one where you can manage all your data, devices and data assets very easily. In your own home, you have absolute control.
+
+## Features
+
+- Friendly UI designed for home scenarios
+  - No code, no forms, intuitive, design for humanity
+- Multiple hardware and base system support
+  - ZimaBoard, NUC, RPi, old computers, whatever is available.
+- Selected apps in the app store, one-click installation
+  - Nextcloud, HomeAssiant, AdGuard, Jellyfin, *arr and more!
+- Easily install numerous Docker apps
+  - Over 100,000 apps from the Docker ecosystem can be easily installed
+- Elegant drive and file management
+  - What you see is what you get. No technical background required.
+- Well-designed system/app widgets
+  - What you care about, at a glance. Resource usage, app status, and more!
 
-![CasaOS](https://raw.githubusercontent.com/IceWhaleTech/logo/main/casaos/casaos_banner_aldeyjarfoss.png)
+## Getting Started
 
-[![Version](https://img.shields.io/github/v/release/IceWhaleTech/CasaOS?color=162453&label=CasaOS&style=flat-square)](https://github.com/IceWhaleTech/CasaOS)
-[![Pull Requests](https://img.shields.io/github/issues-pr/IceWhaleTech/CasaOS?color=162453&style=flat-square)](https://github.com/IceWhaleTech/CasaOS/pulls)
-[![Issues](https://img.shields.io/github/issues/IceWhaleTech/CasaOS?color=162453&style=flat-square)](https://github.com/IceWhaleTech/CasaOS/issues)
-[![GitHub Stars](https://img.shields.io/github/stars/IceWhaleTech/CasaOS?color=162453&logo=github&style=flat-square)](https://github.com/IceWhaleTech/CasaOS/stargazers)
-[![Discord](https://img.shields.io/discord/884667213326463016?color=162453&label=Chat&logo=discord&logoColor=fff&style=flat-square)](https://discord.gg/knqAbbBbeX)
+CasaOS fully supports ZimaBoard, Intel NUC, and Raspberry Pi. Also, more computers and development boards and fully compatible with Ubuntu, Debian, Raspberry Pi OS, and CentOS with one-liner installation.
 
-CasaOS is an open-source Home Cloud system based on the Docker ecosystem and designed for home scenarios. It is committed to building the world's most simple, easy-to-use, and elegant Home Cloud system.
+### Hardware Compatibility
 
-IceWhale team believes that through community-driven collaborative innovation and open communication with global developers, we can reshape the digital home experience like never before.
+- amd64 / x86-64
+- arm64
+- armv7
 
-![CasaOS Snapshot](snapshot.png)
-![CasaOS Snapshot Mobile](snapshot-mobile.png)
+### System Compatibility
 
-## Getting Started
+Official Support
+- Debian 11 (✅ Tested, Recommended)
+- Ubuntu Server 20.04 (✅ Tested)
+- Raspberry Pi OS (✅ Tested)
 
-> ⚠️ Note: 
-> 
-> CasaOS is still in the early development stage and may vary significantly with the final release. Feel free to test run and share your feedback in the [Discord server](https://discord.gg/knqAbbBbeX)!
+Community Support
+- Elementary 6.1 (✅ Tested)
+- Armbian 22.04 (✅ Tested)
+- Alpine (🚧 Not Fully Tested Yet)
+- OpenWrt (🚧 Not Fully Tested Yet)
 
 ### Quick Setup CasaOS
 
-Fresh install a system from the list below and run the this command:
+Freshly install a system from the list above and run this command:
 
 ```sh
 wget -qO- https://get.casaos.io | bash
@@ -47,61 +123,92 @@ curl -fsSL https://get.casaos.io | bash
 
 ### Uninstall CasaOS
 
+
+v0.3.3 or newer
+
+```sh
+casaos-uninstall
+```
+
 Before v0.3.3
 
 ```sh
 curl -fsSL https://get.icewhale.io/casaos-uninstall.sh | bash
 ```
 
-After v0.3.3 and v0.3.3
+## Community 
 
-```
-casaos-uninstall
-```
+The word Casa comes from the Spanish word for "home". Project CasaOS originated as a pre-installed system for crowdfunded product [ZimaBoard](https://www.zimaboard.com) on Kickstarter.
 
-### System Compatibility
+After looking at many systems and software on the market, the team found no server system designed for home scenarios, sadly true.
 
- - Ubuntu Server 20.04 amd64 (✅ Recommend, Tested)
- - Armbian 22.02 armhf/arm64/amd64 (✅ Recommend, Tested)
- - Elementary OS 6.1 Jólnir amd64 (✅ Recommend, Tested)
- - Deepin 20.4 amd64 (⚠️ Not Fully Tested Yet)
- - Raspberry Pi Lite OS aarch64/arm64 (⚠️ Not Fully Tested Yet)
- - Debian 11 amd64 (⚠️ Not Fully Tested Yet)
- - OpenWrt 21.02 amd64 (⚠️ Not Fully Tested Yet)
- - OpenWrt 21.02 aarch64/arm64 (⚠️ Not Fully Tested Yet)
+So, we set out to build this open source project to develop CasaOS with our own hands, everyone in the community, and you.
 
+We believes that through community-driven collaborative innovation and open communication with global developers, we can reshape the digital home experience like never before.
 
-## Key Features
+**A warm welcome for you to get help or share great ideas in the [Discord](https://discord.gg/knqAbbBbeX)!**
 
- - UI designed for home scenarios - simple, elegant, and easy-to-use
- - Quick Docker app installation with only three steps, plus automatic management
- - App Store for Home Cloud 🚧
- - Home data/digital asset management 🚧
- - Smart home manager 🚧
+[![Discord Card](https://discordapp.com/api/guilds/884667213326463016/widget.png?style=banner2)](https://discord.gg/knqAbbBbeX)
 
-🚧 is under development.
+## Contributing
 
-We are actively moving forward with development, and you are more than welcome to share any idea with us!
+CasaOS is a community-driven open source project and the people involved are CasaOS users. That means CasaOS will always need contributions from community members just like you!
 
+<details>
+  <summary><b>How can I get involved? 🧐</b></summary>
+  <p>
 
-## Community
+### Coding 💻 (WIP)
 
-The word Casa comes from the Spanish word for "home". Project CasaOS originated as a pre-installed system for crowdfunded product [ZimaBoard](https://www.zimaboard.com) on Kickstarter.
+We are refining documentation that can be used for effective community collaboration. Feel free to start a discussion if you have a good idea.
 
-After looking at many systems and software on the market, the team found no server system designed for home scenarios, sadly true.
+### Helping Users 💬
 
-So, we set out to build this open source project to develop CasaOS with our own hands, everyone in the community, and you.
+If you have extensive knowledge of CasaOS and related areas. We highly encourage you to help others as much as you can in Discord and Discussions.
 
-> A warm welcome for you to share and discuss your great ideas in the [Discord server](https://discord.gg/knqAbbBbeX)!
+Discord: [https://discord.gg/knqAbbBbeX](https://discord.gg/knqAbbBbeX)
 
-[![Discord Card](https://discordapp.com/api/guilds/884667213326463016/widget.png?style=banner2)](https://discord.gg/knqAbbBbeX)
+GitHub Discussions: [https://github.com/IceWhaleTech/CasaOS/discussions](https://github.com/IceWhaleTech/CasaOS/discussions)
+
+### Helping with Translations 🌍 (WIP)
+
+CasaOS officially supports English and Chinese. You are welcome to help make CasaOS available in more languages.
+
+### Performing Alpha Testing ⚠️
+
+Alpha testing is quality assurance testing that is engaged and driven by the community. It's a great way to get involved in contributing and experiencing the latest features before a new release.
+
+The documentation is being refined and you can contact @JohnGuan via [Discord](https://discord.gg/knqAbbBbeX). Ask to join the #casaos-alpha channel.
+
+### Writing Documentation 📖 (WIP)
+
+Help make our documentation better by writing new content for the CasaOS Wiki, correcting existing material, or translating content into new languages.
+
+  </p>
+</details>
+
+## Credits
+
+Many thanks to everyone who has helped CasaOS so far!
+
+Everyone's contribution is greatly appreciated.
+
+<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
+
+<!-- markdownlint-restore -->
+<!-- prettier-ignore-end -->
+<!-- ALL-CONTRIBUTORS-LIST:END -->
+
+## Changelog
 
+Detailed changes for each release are documented in the [release notes](https://github.com/IceWhaleTech/CasaOS/releases).
 
+---
 
-## Maintainers
- - Jerry Liu
- - Link Liang
- - Ober Zhang
- - Zyaire Ann
- - John Guan
- - Right here, waiting for YOU!
+<p align="center">
+    <a href="https://dashboard.trackgit.com/token/l5q8egi92tfhlxd70l2l">
+        <img src="https://us-central1-trackgit-analytics.cloudfunctions.net/token/ping/l5q8egi92tfhlxd70l2l" alt="trackgit-views" />
+    </a>
+</p>