Simon/famfamfam-silk-svg
1
0
Fork 0
mirror of https://github.com/SimonPistache/famfamfam-silk-svg.git synced 2025-09-10 22:26:28 +02:00
Code Activity

refactor: Update readme

Browse Source
This commit is contained in:
Simon Pistache
2025-01-31 16:09:02 +01:00
parent 7784d9ef1c
commit 0d3144ac75
6 changed files with 17 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
README.md
View File

@@ -3,21 +3,23 @@
# FamFamFam Silk as SVG
> The iconic iconset of the 2010’s era from Mark James, remade in SVG for today’s needs.
## 🚀 How to use
This project contains ~1000 icons in SVG. SVG is lightweight and scalable compared to PNG — and open format, allowing anyone to edit it to his/her needs. I aim to have all the original icons remastered, but also create more up-to-date versions (Smartphones was not a thing back in 2008). Plus, most icons can be mixed with decorators (bullets) to get more meaning.
This work contains ~1000 icons in SVG, feel free to:
![SVG allows scalling](public/scaling.png) ![SVG ease customisation](public/swaping.png) ![SVG ease customisation](public/mixing.png)
## 🚀 How to use
* Clone or fork the repository.
* Download files from the [icons](./icons/) folder.
* (A Figma UI KIT will be released to the community later.)
* (Soon) ~~Get the Figma UI Kit!~~
![All available icons](./public/available-icons.png)
![All available icons](./public/available-icons.png)
## Contributing 🧑‍🎨
Reports, Requests and Contributions are welcomed to this project! I believe that healthy debate and disagreement are essential to a healthy project and community. However, it is never ok to be disrespectful.
#### 🖐️ I would like to report a bug or suggest something!
### 🖐️ I would like to report a bug or suggest something!
The issue section is the right place for you to describe your problem. Specific rules applies, and not following them may result in the closing of the issue.
* Issue must have a label related to your topic
@@ -25,13 +27,13 @@ The issue section is the right place for you to describe your problem. Specific
* Issue may be flagged as _duplicate_ if the topic is already discussed on another issue.
* There is no garanties that an Issue will be resolved. I have limited bandwidth.
#### 🪄 Can I create an icon too?
### 🪄 Can I create an icon too?
Sure! Please *Fork* → *Create* → *Push* → *Pull Request*. Please follow the [Pull Request & commits guidelines](#pull-request-and-commit-guidelines), and the [Icon Design guidelines](#icon-design-guidelines) below.
Sure! Please *Fork* → *Create* → *Push* → *Pull Request*, follow the [Pull Request & commits guidelines](#pull-request-and-commit-guidelines), and the [Icon Design guidelines](#icon-design-guidelines) below.
#### 🩹 I have fixed this icon, how can I give it back?
### 🩹 I have fixed this icon, how can I give it back?
Thank you! Please *Fork* → *Patch* → *Push* → *Pull Request*. Please follow the [Pull Request & commits guidelines](#pull-request-and-commit-guidelines), and the [Icon Design guidelines](#icon-design-guidelines) below.
Thank you! Please *Fork* → *Patch* → *Push* → *Pull Request* and follow the [Pull Request & commits guidelines](#pull-request-and-commit-guidelines), and the [Icon Design guidelines](#icon-design-guidelines) below.
### Pull Request and Commit Guidelines
- It should stick to the [community's best practices](https://github.com/kubernetes/community/blob/master/contributors/guide/pull-requests.md#best-practices-for-faster-reviews) as close as possible
@@ -40,9 +42,9 @@ Thank you! Please *Fork* → *Patch* → *Push* → *Pull Request*. Please follo
- Authors of contribution are credited (via the Contributor section of Github)
### Icon Design Guidelines
- Icons must be in the **style and spirit of the original work** from Marc James.
- Icons must be in the **style and spirit of the original work** from Mark James.
- Icons must be in **SVG**.
- Icons must be designed to be **legible in any size from 16×16px to 64×64px**. It must have the right balance between too much details and too little.
- Icons must be designed to be **legible in any size from 16×16px to 64×64px**. It must have the right balance between too much details and too little. I recommand using a grid of 16×16 to help.
- Icon improvement based on existing icons must be as close as possible to the original design, especially at 16×16px.
- Icon must render without visual artefact in today's broswer such as WebKit, Blink, Gecko. (Test your icons)
@@ -52,7 +54,7 @@ This project is licensed under the [**Creative Commons BY 4**](https://creativec
## Acknowlegements
The Original *FamFamFam Silk* icon pack ([github](https://github.com/markjames/famfamfam-silk-icons) • [website](http://www.famfamfam.com/lab/icons/silk/)) remains the property of Mark James. Please have my thanks and salute for your great work.
The Original *FamFamFam Silk* icon pack ([github](https://github.com/markjames/famfamfam-silk-icons) • [website](http://www.famfamfam.com/lab/icons/silk/)) remains the property of Mark James. Mark, please have my thanks and salute for your great work.
#### Fonts
- [Fira Mono](https://github.com/mozilla/Fira)
@@ -63,12 +65,12 @@ The Original *FamFamFam Silk* icon pack ([github](https://github.com/markjames/f
- [Hind](https://fonts.google.com/specimen/Hind) by the [Indian Type Foundry](https://www.indiantypefoundry.com/)
#### Softwares
- [Gitea](https://about.gitea.com/), an awesome self-hosted github alternative
- [Figma](https://www.figma.com)
- [Figma](https://www.figma.com) as the SVG design software
- [Firefox](https://www.mozilla.org/firefox/new/)
- [Gitea](https://about.gitea.com/), an awesome self-hosted github alternative
- [VSCodium](https://vscodium.com/), a community-driven, freely-licensed binary distribution of Microsoft’s editor VS Code
#### About me
Hi I'm Simon. Computer enthousiast, I have recently switch to become a Product.UX.UI Designer, and used to be a Quality Engineer. I love to create stuff and make them available to all.
Hi I'm Simon. Computer enthousiast, I have recently switch to become a Product.UX.UI Designer, and used to be a Quality Engineer. I love to create stuff and share it.
[linkedin](https://www.linkedin.com/in/simonpriet/) • [behance](https://www.behance.net/SimonPistache#) • [dribbble](https://dribbble.com/SimonPistache) • [github](https://github.com/SimonPistache)