diff --git a/README.md b/README.md index 8ffb181e1..1db091941 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,23 @@ -
-
+
+ A curated collection of logos for programming languages, frameworks, and development tools.
+ Website
+ ·
+ Request an Icon
+ ·
+ Contribute
+ ·
+ Discord
+
- Demo
- ·
- Request Icon
- ·
- Contribute
-
+ Thanks to all our contributors and the IcoMoon app. Devicon would not be possible without you.
+
- Devicon aims to gather all logos representing development languages and tools.
- Each icon comes in several versions: font/SVG, original/plain/line, colored/not colored, wordmark/no wordmark.
- Devicon has 150+ icons. And it's growing!
- See the devicon.json or our website for complete and up to date reference of
- all available icons.
-
- Thanks to all our contributors and the IcoMoon app. Devicon would not be possible without you.
-
- For a super fast setup, go check devicon.dev.
- You can install devicon as a dependency to your project either with
- If you don't want to use a package manager, you can also download
- and include devicon.min.css next to the font files to your project.
- See devicon.dev for details about how to add Devicon to your project via
- a CDN.
-
- After setting up you just have to include the stylesheet in your header
- to get started:
- Start using icons with
- An alternate way to use
- When you want to request an icon please feel free to create an issue. Check out our Wiki for more information.
-
- We are happy with every contribution, whether it's new icons, features, or maintainers. Please have a look at our Wiki to see how you can contribute to this project.
-
-We have a Discord community for Devicons. You can easily request icons, discuss, and have a good time talking with the community members! Join the official Discord Server here!
-
-All official releases shall be in
-After a pull request has been open for over 30 days with no activity or response from the author, it'll be automatically marked as stale. We might fork your changes and merge the changes ourselves. Since GitHub tracks contributions by commits, you will be credited.
-
-Follow these steps to build the website and icons either locally or using Gitpod.io.
- By using Gitpod.io, you can easily build the icons and install the Fork the repository and clone the forked repository. Once all the dependencies are installed, you can proceed to build the newest icons. If there are any errors shown, please let us know by creating an issue or contacting us on our Discord community. Run the following command to build the new CSS stylesheet. Run the following command to start the web server with Python. Or this command, which does exactly the same, but the port can be customized. You're done now! :tada: Your build of Devicons should be available at
+
+
Devicon
+
+ Available as a font, as raw SVGs, or via CDN.
+
@@ -26,294 +44,305 @@
-
-
-
-
-
- Devicon aims to gather all logos representing development languages and tools.
-
- TL;DR
+
+
+## Table of Contents
+
+- [About](#about)
+- [Quick Start](#quick-start)
+- [Usage](#usage)
+ - [Font (recommended)](#font-recommended)
+ - [Inline SVG](#inline-svg)
+ - [Image tag](#image-tag)
+ - [CDN](#cdn)
+- [Requesting an Icon](#requesting-an-icon)
+- [Contributing](#contributing)
+- [Community](#community)
+- [Branches](#branches)
+- [Stale Pull Requests](#stale-pull-requests)
+- [Tools](#tools)
+- [Building Devicon](#building-devicon)
+- [Acknowledgements](#acknowledgements)
+- [Disclaimer](#disclaimer)
+
+## About
+
+Devicon gathers the logos of development languages and tools in one place. Every icon comes in several variants:
+
+| Variant | Options |
+| --- | --- |
+| Format | Font or SVG |
+| Style | `original`, `plain`, `line` |
+| Color | Colored or monochrome |
+| Wordmark | With or without |
+
+Devicon has 600+ icons, and it's growing. See [`devicon.json`](/devicon.json) or [devicon.dev](https://devicon.dev) for the complete, up-to-date list.
+Table of Contents
-
-
-
-develop vs masterAbout the Project
-
-Getting Started
-
- You can either use the raw SVG icons, our Devicon font (which is
- also available via CDN), or by building Devicon yourself.
-Use the
-devicon font (recommended)npm or yarn:
-<i>-tag:devicon is by copy/pasting the raw SVG code
- to your project.
-Copy/paste SVG code (from the SVG folder or the project page):
+### Inline SVG
+
+Copy the SVG code from the [`icons`](https://github.com/devicons/devicon/tree/master/icons) folder or from [devicon.dev](https://devicon.dev) and paste it into your markup:
```html
-
-
+
```
-Add the following CSS rules in your stylesheet:
+Style it with CSS:
```css
.devicon-devicon-plain {
max-width: 2em;
}
-/* if you want to change the original color */
+/* change the original color */
.devicon-devicon-plain path {
fill: #4691f6;
}
```
-You can also use the
+### Image tag
+
+Reference an SVG straight from the repository:
```html
-img tag and reference an SVG directly from the repository:
+
```
-
Requesting an icon
-Contributing
-Discord community
-
-develop vs mastermaster. Any updates in between (icons, features, etc.) will be kept in develop.
-develop contains:
-
-
-
- Can be built manually. See Building Devicon.
- master contains:
-
-
-
-Stale Pull Requests
-Building Devicon
-Table of contents
-
-
-Using Gitpod.io
-
required dependencies in one single click. No extra setup is required.
-
-> **Note**
-> In case some of the commands are not properly ran, you can\
-> follow the steps below and run the same commands on Gitpod.io
-
-
Local Installation
-
-
Install dependencies
-
-
+
+
+
+## Building Devicon
+
+Build the icons and website locally, or use Gitpod to skip the setup.
+
+### Using Gitpod
+
+[Gitpod](https://www.gitpod.io) installs the required dependencies and builds the icons in one click. No extra setup is needed.
+
+[](https://gitpod.io/#https://github.com/devicons/devicon/tree/develop)
+
+> [!NOTE]
+> If a command doesn't run properly on Gitpod, follow the local steps below and run them in the Gitpod terminal.
+
+### Local installation
+
+#### 1. Prerequisites
+
+| Requirement | Notes |
+| --- | --- |
+| [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) | Needed to clone the repository |
+| [Node.js and npm](https://kinsta.com/blog/how-to-install-node-js/) | Required to build Devicon |
+| [Firefox](https://www.mozilla.org/en-US/firefox/new/) | Used for the icon build |
+| [Python 3.8](https://www.python.org/downloads/) | Make sure your install includes [pip](https://pypi.org/project/pip/) |
+
+#### 2. Clone and install dependencies
+
+[Fork](https://github.com/devicons/devicon/fork) the repository, then clone your fork:
```bash
git clone https://github.com/
+
+
+
+
+ Tool
+ Used for
+
+
+
+ Git
+ Version control
+
+
+
+ GitHub
+ Hosting, issues, pull requests, and releases
+
+
+
+ GitHub Actions
+ Automated checks, icon validation, and release workflows
+
+
+
+ Node.js & npm
+ Build scripts, dependencies, and publishing the
+ devicon package
+
+
+ Python
+ Automation scripts and the local development server
+
+
+
+ Selenium
+ Browser automation to generate the icon font
+
+
+
+ Firefox
+ Browser used by Selenium during the icon build
+
+
+ 🎨
+ IcoMoon
+ Converting SVGs into the Devicon icon font
+
+
+
+ Gitpod
+ One-click, preconfigured development environment
+
+
+ 📦
+ jsDelivr
+ CDN delivery of the stylesheet, fonts, and SVGs
+
+
+
+
+ Discord
+ Community support and icon requests
+ Install all the necessary NPM dependencies
+Install the Node and Python dependencies:
```bash
npm install
-```
-
-> **Note**
-> 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.
-
-Install Firefox
-https://www.mozilla.org/en-US/firefox/new/
-
-Install Python 3.8
-https://www.python.org/downloads/
-
-> **Note**
-> Make sure your Python install includes [pip](https://pypi.org/project/pip/)
-
-Install Dependencies
-
-```bash
python -m pip install -r ./.github/scripts/requirements.txt
```
-Build the new icons
+#### 3. Build the icons
-
-Usually, this is done on each release, but you can have a sneak peek before a release.Build the CSS stylesheet
+#### 4. Build the CSS stylesheet
-
-This file is used to show all the new icons previously built.Setting up the web server
-
-https://localhost:8000 (or the desired port).
+Thanks to all of our [contributors](https://github.com/devicons/devicon/graphs/contributors) and to the [IcoMoon app](https://icomoon.io/#home). Devicon would not be possible without you.
+
+## Disclaimer
+
+All product names, logos, and brands are property of their respective owners. All company, product, and service names used in this project are for identification purposes only. Use of these names, logos, and brands does not imply endorsement. Please use these logos in accordance with each company, brand, or service's brand policy.
+
+
-
+
+