This is my contribution to Superalgos
This commit is contained in:
Luis Fernando Molina committed
1 parent
145ea8c485
commit
8d6efb116a
1 file changed
+21
-21
@@ -12,11 +12,11 @@ If you don't have it yet, download and install Node.js.
|
||||
|
||||
Node JS is an open-source server environment required to run Superalgos.
|
||||
|
||||
a. Go to the Node JS [download page](https://nodejs.org/en/download/).
|
||||
**a.** Go to the Node JS [download page](https://nodejs.org/en/download/).
|
||||
|
||||
b. Download your system’s installer. Select LTS Recommended for Most Users and click the big Windows or MacOS Installer button. If you are on Linux, the installer is listed further down.
|
||||
**b.** Download your system’s installer. Select LTS Recommended for Most Users and click the big Windows or MacOS Installer button. If you are on Linux, the installer is listed further down.
|
||||
|
||||
c. Run the installer with the default configuration—just click Next until Node.JS is fully installed.
|
||||
**c.** Run the installer with the default configuration—just click Next until Node.JS is fully installed.
|
||||
|
||||
### Git
|
||||
|
||||
@@ -24,19 +24,19 @@ If you don't have it yet, download and install Git.
|
||||
|
||||
Please install Git, an open-source distributed version control system required to download and stay up to date with Superalgos.
|
||||
|
||||
a. Go to the Git [download page](https://git-scm.com/downloads).
|
||||
**a.** Go to the Git [download page](https://git-scm.com/downloads).
|
||||
|
||||
b. Download the version for your Operating System
|
||||
**b.** Download the version for your Operating System
|
||||
|
||||
c. Run the installer and go through the process until Git is fully installed.
|
||||
**c.** Run the installer and go through the process until Git is fully installed.
|
||||
|
||||
### Google Chrome
|
||||
|
||||
Use Chrome, the Only Tested Browser.
|
||||
|
||||
a. Go to the Chrome [download page](https://www.google.com/chrome/).
|
||||
**a.** Go to the Chrome [download page](https://www.google.com/chrome/).
|
||||
|
||||
b. Run the installer.
|
||||
**b.** Run the installer.
|
||||
|
||||
Before you begin, it is highly recommended that you install Chrome and set it up as your default browser (if you don't already have it).
|
||||
|
||||
@@ -44,22 +44,22 @@ Before you begin, it is highly recommended that you install Chrome and set it up
|
||||
|
||||
## Superalgos App Installation
|
||||
|
||||
1. If you are not already here, goto to: [https://github.com/Superalgos/Superalgos](https://github.com/Superalgos/Superalgos)
|
||||
2. At the up-right corner of this page, press the fork button to create your own fork / copy of this repository.
|
||||
3. At the page of your fork, copy the URL from your browser address bar.
|
||||
4. At your computer / laptop / server, open a command prompt or terminal as an administrator and start typing:
|
||||
**1.** If you are not already here, goto to: [https://github.com/Superalgos/Superalgos](https://github.com/Superalgos/Superalgos)
|
||||
**2.** At the up-right corner of this page, press the fork button to create your own fork / copy of this repository.
|
||||
**3.** At the page of your fork, copy the URL from your browser address bar.
|
||||
**4.** At your computer / laptop / server, open a command prompt or terminal as an administrator and start typing:
|
||||
|
||||
```
|
||||
git clone
|
||||
```
|
||||
|
||||
5. Paste the URL of your fork to complete the git clone command.
|
||||
**5.** Paste the URL of your fork to complete the git clone command.
|
||||
|
||||
```
|
||||
git clone + URL of your Fork of Superalgos.
|
||||
```
|
||||
|
||||
6. For example, if your Github username is John, the command will look like this:
|
||||
**6.** For example, if your Github username is John, the command will look like this:
|
||||
|
||||
```
|
||||
git clone https://github.com/John/Superalgos
|
||||
@@ -67,26 +67,26 @@ git clone https://github.com/John/Superalgos
|
||||
|
||||
### Instalation Notes
|
||||
|
||||
1. You need to make a fork in order for the App functionality that facilitates contributions to work.
|
||||
2. You need to run the command git clone as an administrator in order to avoid permission problems while creating the Superalgos folder and downloading the repository there. It might also work without admin power, depending on your setup.
|
||||
**1.** You need to make a fork in order for the App functionality that facilitates contributions to work.
|
||||
**2.** You need to run the command git clone as an administrator in order to avoid permission problems while creating the Superalgos folder and downloading the repository there. It might also work without admin power, depending on your setup.
|
||||
|
||||
## Usage
|
||||
|
||||
|
||||
|
||||
1. Run the Superalgos Client doing this: change to the Superalgos directory / folder and type:
|
||||
**1.** To run the Superalgos client, change to the Superalgos directory / folder and type:
|
||||
|
||||
```
|
||||
node run
|
||||
```
|
||||
|
||||
2. The UI will be loaded at your default browser. Be patient it make take a minute to fully load.
|
||||
3. A Welcome Tutorial will automatically pop-up. You need to do this Tutorial to finish the setup and to learn the basics. It's the ultimate onboarding experience, superior to all other resources available, including videos and the docs.
|
||||
**2.** The UI will be loaded at your default browser. Be patient it make take a minute to fully load.
|
||||
**3.** A Welcome Tutorial will automatically pop-up. You need to do this Tutorial to finish the setup and to learn the basics. It's the ultimate onboarding experience, superior to all other resources available, including videos and the docs.
|
||||
|
||||
### Usage Notes
|
||||
|
||||
1. We have only tested the UI with Google Chrome. It might work with other browsers as well, or it might not.
|
||||
2. Before installing the client in a different hardware that from where you are going to load the UI, we reccomend you to first do a standard installation at your PC / laptop, and leave your Raspberry Pi or Server for after you have done all available tutorials. This single tip will save you a lot of time.
|
||||
**1.** We have only tested the UI with Google Chrome. It might work with other browsers as well, or it might not.
|
||||
**2.** Before installing the client in a different hardware that from where you are going to load the UI, we reccomend you to first do a standard installation at your PC / laptop, and leave your Raspberry Pi or Server for after you have done all available tutorials. This single tip will save you a lot of time.
|
||||
|
||||
**Tip:** If your computer has less than 8 GB of RAM, use node run minMemo to run the system with minimal RAM memory requirements.
|
||||
|
||||
|
||||
Reference in new issue
Block a user