Add new README.md

armbian · Oct 14, 2024 · 051d944 · 051d944
1 parent 2a8e8b0
commit 051d944
Show file tree

Hide file tree

Showing 6 changed files with 24 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,24 @@
+<p align="center">
+  <a target="_blank" href="https://docs.armbian.com">
+    <img alt="logo" src="./docs/images/logo.png" width=128>
+  </a><br>
+  <strong>Armbian Documentation</strong><br>
+<br>
+<a href=https://github.com/armbian/documentation/actions/workflows/pdf-at-pr.yaml><img alt="GitHub Workflow Status" src="https://img.shields.io/github/actions/workflow/status/armbian/documentation/pdf-at-pr.yaml?logo=githubactions&label=HTML%20page&style=for-the-badge&branch=main"></a>
+</p>
+
+## Online editing 
+
+Documentation edition goes in three simple steps.
+
+|Step|Description|Visuals|
+|:-------:|---|---:|
+| 1. | Open <a href=https://docs.armbian.com/ target="_blank">website</a> and find content you want to change.| <a href=#><img alt="logo" src="./docs/images/edit-icon.png"></a>|
+| 2. | When you are done with editing, commit changes. |<a href=#><img alt="logo" src="./docs/images/commit-changes.png"></a> |
+| 3. | Enter title and description of changes you are proposing. | <a href=#><img alt="logo" src="./docs/images/propose-changes.png"></a> |
+| 4. | Create a pull request. |<a href=#><img alt="logo" src="./docs/images/create-pull-reqest.png"></a> |
+| 5. | Verify your changes on rendered preview at your pull reqest. |<a href=#><img alt="logo" src="./docs/images/wait-for-preview.png"></a> |
+
+## Offline editing 
+
+Please reffer to [those instructions](/DOCUMENTATION.md)
diff --git a/docs/images/commit-changes.png b/docs/images/commit-changes.png
diff --git a/docs/images/create-pull-reqest.png b/docs/images/create-pull-reqest.png
diff --git a/docs/images/edit-icon.png b/docs/images/edit-icon.png
diff --git a/docs/images/propose-changes.png b/docs/images/propose-changes.png
diff --git a/docs/images/wait-for-preview.png b/docs/images/wait-for-preview.png