devicons / devicon

Set of icons representing programming languages, designing & development tools
https://devicon.dev
MIT License
9.88k stars 2.32k forks source link

[OTHER] Update build description in README.md #1414

Open Snailedlt opened 2 years ago

Snailedlt commented 2 years ago

I have searched through the issues and didn't find my problem.

What would you like to share?

The build description in the README.md is incomplete and hard to read, and shouold be updated for completeness and readability's sake.

https://github.com/devicons/devicon/tree/develop#go-build-yourself

I've identified a few concrete things that should be improved, but I'm sure there are more, since I haven't gone through the whole build process successfully myself. So without further to do, here are a few of the things I think needs improvement:

  1. Install gulp (and gulp plugins) should link to gulp and gulp plugins, and explain in short how to install it. Maybe we can even get rid of this if it can be automated through a build script?
  2. This part is incomprehensible to me. Where should I extract the archive? What files do I keep/remove/replace? Do I keep parts of the zip contents, or just some?

    The next step is to click on Generate font and download the resulting archive. Extract the contents and you will find a fonts directory next to a style.css. Replace the contents of the fonts folder, rename style.css as devicon.css and follow the next step to build the final stylesheet.

  3. There should be mention of the need for a server to host. I think this can be added to the README:

    The website will need access to your files via fetch so you'd need a server to host it. For VSCode we recommend using the Live Server extension. You can then click on the Go Live in the bottom right corner of your VSCode status bar. image. After that open up http://127.0.0.1:5500/docs/ to view the website locally.

Additional information

I'm labeling this issue as a discussion so if you have any suggestions to improving the readability of the Build section of the README, please feel free to write some comments below

Snailedlt commented 2 years ago

@Panquesito7 perhaps you could help with this?

Panquesito7 commented 1 year ago

@Panquesito7 perhaps you could help with this?

Sure, I can help with that. The only thing is, I'm not 100% sure how the compilation process is done. I've tried it several times on Gitpod, but nothing appears. I'll try again right now and will let you know and potentially create a PR. Thanks. 🙂

Panquesito7 commented 1 year ago

Well, I found a way of compiling it through Gitpod. There's no need to download or install anything: all should be done automatically. I guess we should encourage users to do it that way now. We should still provide a list of steps just in case.

Snailedlt commented 1 year ago

@Panquesito7 That's awesome! Yeah, if that's easier and free it should be encouraged. But like you said, we still need the build steps for other contributors :)

Panquesito7 commented 1 year ago

You can try and compile it on Gitpod here https://gitpod.io/#https://github.com/Panquesito7/devicon/tree/panquesito7/improve/build It does work and everything (although some commands may not, check .gitpod.yml), however, it does not take the data from devicon.min.css properly for some strange reason.

I'll check out that issue tomorrow. Feel free to check as well. 🙂

Snailedlt commented 1 year ago

@Panquesito7 do you know what that part of the code does?

Panquesito7 commented 1 year ago

@Panquesito7 do you know what that part of the code does?

Which part of the code? Also, I think the issue's because of this: https://github.com/devicons/devicon/actions/runs/4078484614/jobs/7028748346#step:8:14 I modified the gulpfile.js to still add those by adding !optional, but that seemed to cause an issue as well, not sure, though. 🤔

Snailedlt commented 1 year ago

I'm a bit confused by why we have that issue in Gitpod though. I don't have the same issue locally

Which part of the code?

The part that the build job complains about:

Error: The target selector was not found.
Use "@extend .devicon-amazonwebservices-original-wordmark !optional" to avoid this error.
Panquesito7 commented 1 year ago

Hmm. Not sure what that does for us. 🤔