Final Touches to the Readme

This commit is contained in:
Luis Fernando Molina committed 2021-01-13 09:18:27 +01:00
1 parent af2c251b98
commit 2afee5b654
1 file changed
+8 -6
+8 -6
View File
@@ -46,7 +46,7 @@ Before you begin, it is recommended that you set up Chrome as your default brows
**1.** If you are not there already, go to [https://github.com/Superalgos/Superalgos](https://github.com/Superalgos/Superalgos)
**2.** Scroll the page all the way to the top. Find and click the **Star** button on the top-right corner of the page to like Superalgos! Thank you! This helps developers find the project, which makes Superalgos better for you through their contributions.
**2.** Scroll the page all the way to the top. Find and click the **Star** button on the top-right corner of the page to like Superalgos! Thank you! This helps developers find the project, which makes Superalgos better for you through their contributions. This step is in fact, your first contribution.
**3.** Next to the Star button, find and click the **Fork** button to create your fork/copy of this repository. To fork Superalgos you need a GitHub account. If you don't have one, go ahead and create one. A Fork is required for your contributions to the project and to stay up to date with the latest version of the software (more on this later).
@@ -74,11 +74,9 @@ git clone https://github.com/John/Superalgos
**1.** You need to make a fork so that you may contribute work. Superalgos is a Community project and you are expected to contribute, like everyone else. You don't need to be a technical person to contribute. Fixing a typo in the docs or translating a paragraph into your native language are valuable contributions too. Superalgos has built-in features that make contributing easy. Help make Superalgos better and Superalgos will better serve you! [Free-riding is not cool](https://en.wikipedia.org/wiki/Free-rider_problem), particularly on free, open-source, Community-driven projects.
**2.** You also need a fork to use the in-app self-update features. These will help you stay up-to-date with the latest version of the software. Updates are on-demand, so don't worry about undesired updates. The project moves very fast and new features become available regularly.
**2.** You are better off running the git clone command as an administrator to avoid permission issues while creating the Superalgos folder and downloading the repository. It may work without admin powers depending on your setup, particularly if you are running the command on a folder where you've got write permissions.
**3.** You are better off running the git clone command as an administrator to avoid permission issues while creating the Superalgos folder and downloading the repository. It may work without admin powers depending on your setup, particularly if you are running the command on a folder where you've got write permissions.
**4.** Before installing the client on a remote computer in an attempt to access the UI from a different machine, we highly recommend you do a standard installation on your PC / laptop first. Leave your Raspberry Pi or server for later, once you have done all available tutorials. This single tip will save you a lot of time: you don't need to add complexity before you learn how to handle the app.
**3.** Before installing the client on a remote computer in an attempt to access the UI from a different machine, we highly recommend you do a standard installation on your PC / laptop first. Leave your Raspberry Pi or server for later, once you have done all available tutorials. This single tip will save you a lot of time: you don't need to add complexity before you learn how to handle the app.
# Usage
@@ -225,6 +223,10 @@ Superalgos features interactive documentation.
Subscribe to the [Superalgos YouTube Channel](https://www.youtube.com/channel/UCmYSGbB151xFQPNxj7KfKBg).
## In-App Tutorials
There are many interactive tutorials you can use to learn from.
# Other Resources
## Web Site
@@ -253,7 +255,7 @@ Or follow [Superalgos on Facebook](https://www.facebook.com/superalgos).
# Contributing
Superalgos is a Community Project built by Contributors. Learn [how to become a Contributor](https://docs.superalgos.org/contributing-to-superalgos.html).
Superalgos is a Community Project built by Contributors for Contributors. Learn [how to become a Contributor](https://docs.superalgos.org/contributing-to-superalgos.html).
## Top Contributors