From 7cf5468035d5e58327f8e94e3896c2ab6b2b62ce Mon Sep 17 00:00:00 2001
From: Simon Pistache <105607989+SimonPistache@users.noreply.github.com>
Date: Fri, 31 Jan 2025 17:53:22 +0100
Subject: [PATCH] Improve presentation (#188)
* feat: Init Contribution and fill Readme
* docs: Add illustrations to readme, write contribution
Add more details on the various sections of the ReadMe and illustrations. Complete the Contribution file with descriptions and more guidelines. Contains changes for milestones 2.
* docs: Merge CONTRIBUTING and README
To start small, I don't think I need a CONTRIBUTING, CODE_OF_CONDUCT and CHANGELOG files. All should fit in the README for now.
* refactor: Update Readme with link to CC docs.
Also remove the `thumb up` and `thumb down` icons, as they are not completed yet.
* fix: Remove references to the Figma UI Kit.
The Figma Kit will be linked back here when it will be published on the Community.
* refactor: Update readme
* refactor: Update ReadMe
Change some illustration from PNG to SVG.
* fix: backlinks not working on github
* fix: backlink not respecting file Capitalization
* style(identity): decorate headers with icons
Replace emojis with icons (because why not)
* fix(identity): remove inline css in imgs
Github eat custom inline CSS in the style attributes to put its own. It's better to have icons on the right for now.
* fix(identity): fix a header issue in ReadMe
* fix(identity): Reduce icons size to match github headers hights
* Revert "fix(identity): Reduce icons size to match github headers hights"
This reverts commit 2ae463bdbbe5d59ea1de746372e3978f272cafc5.
---
README.md | 92 +++++++++++++++++++++++++++++----
icons/thumb_down.svg | 9 ----
icons/thumb_up.svg | 9 ----
public/Cup of caffe.svg | 31 +++++++++++
public/Cup of matcha.svg | 31 +++++++++++
public/Cup of tea.svg | 31 +++++++++++
public/Cup of water.svg | 31 +++++++++++
public/I should stop caffe.svg | 46 +++++++++++++++++
public/available-icons.png | Bin 0 -> 1157676 bytes
public/github-cover.png | Bin 0 -> 431684 bytes
10 files changed, 251 insertions(+), 29 deletions(-)
delete mode 100644 icons/thumb_down.svg
delete mode 100644 icons/thumb_up.svg
create mode 100644 public/Cup of caffe.svg
create mode 100644 public/Cup of matcha.svg
create mode 100644 public/Cup of tea.svg
create mode 100644 public/Cup of water.svg
create mode 100644 public/I should stop caffe.svg
create mode 100644 public/available-icons.png
create mode 100644 public/github-cover.png
diff --git a/README.md b/README.md
index a400d54..8ae9fb7 100644
--- a/README.md
+++ b/README.md
@@ -1,16 +1,86 @@
-# famfamfam-silk-svg
-A recreation of the iconic iconset of the 2010’s era from Marc James, remade in SVG and as a figma UI kit for today’s developpers and designers needs.
+
-## License
+# FamFamFam Silk as SVG
+> The iconic iconset of the 2010’s era from Mark James, remade in SVG for today’s needs.
-I have not settled on the right licence for this product, so as for now I'll follow Mark James' Create Commons Attribution. He used 2.5, but I picked version 4.
-I would like a more protective licence, one that could permit company and users to pick stuff here and use them in commercial products and marketing material, but prevent "stealing" stuff or changing ownership over minimal visual changes.
+This project contains ~1000 icons in SVG. SVG is lightweight, 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.
-## Contribution
+Scale:
-- All enhancement are welcomed
-- Contributions must be in form of a PR to the main branch
+Mix: ![Cup of caffee]() + ![Bullet delete]() = ![A cup of caffe with a delete bullet at its bottom right]()
-Contributions can be
-- fixes or improvements over the existing icons
-- new icons in the strict aestetics of the original work
\ No newline at end of file
+Customize: ![Cup of caffee]() ![Cup of Matcha latte]() ![Cup of Tea]() ![Cup of water]()
+
+## How to use
+
+* Clone or fork the repository.
+* Download files from the [icons](./icons/) folder.
+
+
+
+### Roadmap
+
+* (Soon) Designers: Get the Figma UI Kit
+* (Soon) Access to more decorators
+* (Soon) Access to variants
+* (Soon) Access to parts
+
+## 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!
+
+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
+* Issue must be sufficiently described, clear and not misleading
+* 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?
+
+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?
+
+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
+- It must follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/#summary) principles in commit and PR names.
+- It must be related to an issue in this project.
+- 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 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. 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)
+
+## License
+
+This project is licensed under the [**Creative Commons BY 4**](https://creativecommons.org/licenses/by/4.0/) license. This content is distributed in the hope that it will be useful, but **without any warranty**; without even the implied warranty of **merchantability** or **fitness for a particular purpose**.
+
+## 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. Mark, please have my thanks and salute for your great work.
+
+#### Fonts
+- [Fira Mono](https://github.com/mozilla/Fira)
+- [Fira Sans](https://github.com/mozilla/Fira)
+- [Fira Sans Condensed](https://github.com/mozilla/Fira)
+- [Love Ya Like a Sister](https://fonts.google.com/specimen/Love+Ya+Like+A+Sister) by [Kimberly Geswein](https://kimberlygeswein.com/)
+- [Segoe UI](https://learn.microsoft.com/en-us/typography/font-list/segoe-ui) (for Office logos)
+- [Hind](https://fonts.google.com/specimen/Hind) by the [Indian Type Foundry](https://www.indiantypefoundry.com/)
+
+#### Softwares
+- [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 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)
\ No newline at end of file
diff --git a/icons/thumb_down.svg b/icons/thumb_down.svg
deleted file mode 100644
index 2ffbf9c..0000000
--- a/icons/thumb_down.svg
+++ /dev/null
@@ -1,9 +0,0 @@
-
diff --git a/icons/thumb_up.svg b/icons/thumb_up.svg
deleted file mode 100644
index e79324a..0000000
--- a/icons/thumb_up.svg
+++ /dev/null
@@ -1,9 +0,0 @@
-
diff --git a/public/Cup of caffe.svg b/public/Cup of caffe.svg
new file mode 100644
index 0000000..14dde48
--- /dev/null
+++ b/public/Cup of caffe.svg
@@ -0,0 +1,31 @@
+
diff --git a/public/Cup of matcha.svg b/public/Cup of matcha.svg
new file mode 100644
index 0000000..803f6f3
--- /dev/null
+++ b/public/Cup of matcha.svg
@@ -0,0 +1,31 @@
+
diff --git a/public/Cup of tea.svg b/public/Cup of tea.svg
new file mode 100644
index 0000000..8a5084f
--- /dev/null
+++ b/public/Cup of tea.svg
@@ -0,0 +1,31 @@
+
diff --git a/public/Cup of water.svg b/public/Cup of water.svg
new file mode 100644
index 0000000..5258cd5
--- /dev/null
+++ b/public/Cup of water.svg
@@ -0,0 +1,31 @@
+
diff --git a/public/I should stop caffe.svg b/public/I should stop caffe.svg
new file mode 100644
index 0000000..be113a9
--- /dev/null
+++ b/public/I should stop caffe.svg
@@ -0,0 +1,46 @@
+
diff --git a/public/available-icons.png b/public/available-icons.png
new file mode 100644
index 0000000000000000000000000000000000000000..ca81f88ce68fd7482fc17e6a7635d4b66cb05225
GIT binary patch
literal 1157676
zcmZ^JWl$W^(l+iI+${um2)4KfStJAq?(PH@cXvXN084O4a0u>hVR82b7J{?5e!1_j
z@5jAQ)zs8EHC0pHPtTd|emYiDLkSm)5(@zV0ary?UK;@cO#}e}B?ANP-%h4O$<)6a
zrkk>XCjtT~^M5Wx745g@|27dlwUuNMswb%r|1D5#Wz=O55bBb#pUhDa2rGJ3LZ`$?d#w!e(-Wq!Jh9J(WH#78lsbNP%n0?12uy_-r67qwG;avm@h7gLZ
zDo!y%K~@r56CaI}6AroFsIGCDcUzPAYkJ=La_3jCX1!WC#Iokp<)}etBina80qIbV
zd*j2!r;ujG4&U>AG|c~s*jLkn9j=IG-i?Rzg`!st3asKJtU!+c@ib=aHert;)rJ@Y
zYO%!@Jz64K$6m@KsMBNw0=Z455pN2f$l?oEqV=^p5bnND#Cr4J@oKvB-Ld*2;9`(W
z^k}gLa`yKxJ0&&sl>#H7Mb1=+!WSp>=qNlEG(7(6IlDl(S-)cA&!0c9A2(lvhVx&a
zV64jj1301X&>`L5jg50=a_9#8VdP?;Lny@3u)ZrV^vEnMXT>zXNgggrpcHbT8p2EY
zA5cd6{rk6Nlk27l{zUC`aM`xCEaqWNjaD+G_a=0J#_~A8y3dENl+8-|b22DGu+1<+Fr<+Iz(tr2d
z+qe8Nxw*N|OsN={eM=+#RT)3ZD8~ah_bunPtH&1@ydrR|i$}4F4Ue<{x!+FP4kP
zu7MWEF?F^BhT-9r+8T`FBUc}VKsx?@ehZ-y{~hvC+a9f9HQg@{tY*FBZ^Obl-)q=_
z>*d{-%F1_+TnJJQ5?6M1c5XH{HgNyv>rvCw)76fTj+ngToI#F@K86cW0y(jfTk35e
z!h0zE-cRPgaxE*%s9Ii8vE39KVBSm?(StkPlWN%xegTWPTOj-|N7YC0Sq{0a%BR-m
z@YKj`zme>0IyzKou=#`aKTXV_UwU`!7)zx^9aqZ)@tz6V#g{#h`yT|Rj4%=_h<<#1
zXgwh?j_)se9YOq0oW