From 95bdb52154eb0c8e8825d07156885ed259f691cb Mon Sep 17 00:00:00 2001 From: David Leal Date: Wed, 8 Feb 2023 01:35:54 +0000 Subject: [PATCH] Cleanup and fix path --- README.md | 31 +++++++++++++++-------------- docs/index.html | 52 +++++++++++++++++++++++++++++++++++++------------ 2 files changed, 56 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index 34a70237..3b8bd4da 100644 --- a/README.md +++ b/README.md @@ -217,13 +217,12 @@ Follow these steps to build the website and icons either locally or using Setting up the web server -

Using Gitpod.io

-

By using Gitpod.io, you can easily build the icons
and install the required dependencies in one single click. No extra setup is required.

+

Using Gitpod.io

+

By using Gitpod.io, you can easily build the icons and install the
required dependencies in one single click. No extra setup is required.

Open in Gitpod -

Installation

-
Forking and cloning the repository +

Installation

Fork the repository and clone the forked repository.

@@ -233,7 +232,7 @@ git clone https://github.com//devicon.git

In case you don't have Git installed, check the official guide to install Git on your operating system.

-
Install all the necessary NPM dependencies
+

Install all the necessary NPM dependencies

In case you don't have NPM installed, check this ultimate guide on installing Node.js and NPM. These tools are required in order to build Devicon properly.

@@ -241,9 +240,9 @@ git clone https://github.com//devicon.git npm install ``` -

Installing Mozilla Firefox
+

Installing Mozilla Firefox

-

Install on Linux-based systems using sudo

+

Install on Linux-based systems using sudo

```bash sudo apt-get install firefox @@ -251,9 +250,9 @@ sudo apt-get install firefox

Install Mozilla Firefox on Windows: https://support.mozilla.org/en-US/kb/how-install-firefox-windows

-
Installing Python3
+

Installing Python3

-

Install Python3 using the sudo command.

+

Install Python3 using the sudo command.

```bash sudo apt-get install python3 @@ -263,7 +262,7 @@ sudo apt-get install python3
For a more detailed guide on installing Python, check this tutorial built by the DigitalOcean community.

-
Setting up Selenium
+

Setting up Selenium

Install Selenium in both Linux-based and Windows sytems.

@@ -271,7 +270,7 @@ For a more detailed guide on installing Python, check Build the new icons +

Build the new icons

Once all the dependencies are installed, you can proceed to build the newest icons.
Usually, this is done on each release, but you can have a sneak peek before a release.

@@ -291,7 +290,7 @@ python3 ./.github/scripts/icomoon_build_githubless.py ./.github/scripts/build_as The process might take a while, depending on your operating system's speed and the amount of icons.

If there are any errors shown, please let us know by creating an issue or contacting us on our Discord community.

-

Build the CSS stylesheet

+

Build the CSS stylesheet

Run the following command to build the new CSS stylesheet.
This file is used to show all the new icons previously built.

@@ -300,20 +299,22 @@ This file is used to show all the new icons previously built.

npm run build-css ``` -

Setting up the web server

+

Setting up the web server

-

Feel free to either open the `docs/index.html` file, or run the following command to run the Python web server.

+

Run the following command to start the web server with Python.

```bash npm run dev # Will run on port 8000 ``` -

Or this command, which does exactly the same, but the port can be customized

. +

Or this command, which does exactly the same, but the port can be customized.

```bash python3 -m http.server ``` +

You're done now! :tada: Your build of Devicons should be available at https://localhost:8000.

+
diff --git a/docs/index.html b/docs/index.html index 93f42c64..986431f1 100644 --- a/docs/index.html +++ b/docs/index.html @@ -39,6 +39,9 @@