-
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
e3bd085
commit b6b2185
Showing
4 changed files
with
169 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,2 +1,75 @@ | ||
| # scicon | ||
| Science Themed CSS Icon Pack by the Sci-Hook Organization | ||
| This informative text aims to provide brief information about the package. Therefore, it is written in a very short and detailed way. However, a developer who reads this information will be able to start using the package easily. Please [visit](https://github.com/Sci-Hook/scicon/wiki) the official Scicon documentation for more detailed information. | ||
|
|
||
| # General Information  | ||
|
|
||
| Icons are a good choice to make your projects better from a design and visual point of view. Scicon Icon Pack is an icon pack that you can freely use in your work. If you wish, you can include all Scicon icons in your project by installing this package directly, or you can install the other categories of the Scicon Icon Package separately and include the icons in the icon category you want in your project. | ||
|
|
||
| # Installation and Usage | ||
|
|
||
| There are two recommended ways to use the icon package: include it via CDN and install it via npm. Below we describe how you can use these two methods: | ||
|
|
||
| ## Include via CDN  | ||
|
|
||
| To use the package via CDN, you need to use jsDelivr. You can use the CDN link below: | ||
|
|
||
| `https://cdn.jsdelivr.net/gh/sci-hook/scicon@latest/style.css` | ||
|
|
||
| You can use the code below to include the package directly in your project: | ||
|
|
||
| `<link rel="stylesheet" href="https://cdn.jsdelivr.net/gh/sci-hook/scicon@latest/style.css">` | ||
|
|
||
| You can add the above code to the `<head>` tag of the file where you will use the icon pack. | ||
|
|
||
| ## Include via npm  | ||
|
|
||
| To install the package via npm, run the following code in the terminal: | ||
|
|
||
| `$ npm i scicon` | ||
|
|
||
| Then you can add it to your SCSS file as follows: | ||
|
|
||
| `@import 'node_modules/scicon';` | ||
|
|
||
| # Documentation and Help | ||
|
|
||
| More detailed documentation is available for the Scicon Pack. Please check the GitHub wiki page for the Scicon Pack to get detailed information about the installation, track changes and get answers to your questions. If you cannot find answers on the wiki page, you can ask them as an issue via GitHub. Sci-Hook Scion Development Team will help you. | ||
|
|
||
| [Scicon GitHub Wiki Page](https://github.com/Sci-Hook/scicon/wiki) | ||
|
|
||
| [Scicon Github Issues Page](https://github.com/Sci-Hook/scicon/issues) | ||
|
|
||
| # Versioning   | ||
|
|
||
| When versioning the Scicon Icon Pack, we combine Semantic Versioning with our own versioning system. Here's how we version the icons: | ||
|
|
||
| `<main-version (major)>.<icon-update (minor)>.patch>` | ||
|
|
||
| The major release is the top version of the package and includes major changes. These major changes include software changes and important updates such as new icon styles. We recommend that you always keep the major version of the Scicon Pack up to date. | ||
|
|
||
| The icon update includes new, updated and removed icons. For each icon change, the version is incremented once. For example, if 5 new icons are added and 3 icons are removed in the new version of the package version 2.0.1, the new version will be 2.8.1. | ||
|
|
||
| Patches include software bug fixes, typos and minor icon fixes. Patches do not include major changes. However, it is still important to use the stable version of the package to get the most out of it. | ||
|
|
||
| # Icon Request, Bug Reporting, Suggestions and Contributions | ||
|
|
||
| You can use GitHub's issues section to request new icons, report bugs, offer suggestions and contribute to the development of the package. The Issues section will guide you on what you need to do. Thank you for your contribution to the development of the package. | ||
|
|
||
| [Scicon Github Issues Page](https://github.com/Sci-Hook/scicon/issues) | ||
|
|
||
| # Contributors | ||
|
|
||
| The design and software works of the icons in the package are carried out by [Çınar Civan](https://github.com/cinarcivan). Software technical works are carried out by [Emirhan Gerçeker](https://github.com/lim10tech). | ||
|
|
||
| # License | ||
|
|
||
| All icons in the pack are provided under the Creative Commons Attribution-ShareAlike 4.0 International Public (CC BY-SA 4.0) License. | ||
|
|
||
| The package's Scicon font is available under the Open Font License (OFL). | ||
|
|
||
| The source codes of the package are available under the MIT License. | ||
|
|
||
| You can view the legal text [here](https://github.com/Sci-Hook/scicon/blob/main/LICENSE). | ||
|
|
||
| # View This Description in Other Languages | ||
|
|
||
| Türkçe (Turkish): [Bu açıklamayı Türkçe görüntülemek için tıkla!](https://github.com/Sci-Hook/scicon/blob/main/READMETR.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,75 @@ | ||
| Bu bilgilendirme yazısı, paket hakkında özet bilgi vermeyi hedeflemektedir. Dolayısıyla oldukça kısa ve detaysız bir şekilde yazılmıştır. Ancak bu bilgilendirme yazısını okuyan bir geliştirici paketi rahatlıkla kullanmaya başlayabilecektir. Lütfen daha detaylı bilgilendirme için resmî Scicon dokümanlarını [ziyaret ediniz](https://github.com/Sci-Hook/scicon/wiki). | ||
|
|
||
| # Genel Bilgilendirme  | ||
|
|
||
| Projelerinizi tasarımsal ve görsel açıdan daha iyi hale getirmek için ikonlar oldukça iyi bir seçimdir. Scicon İkon Paketi, çalışmalarınızda özgürce kullanabileceğiniz bir ikon paketidir. Dilerseniz doğrudan bu paketi kurarak bütün Scicon ikonlarını projenize dahil edebilir, dilerseniz de Scicon İkon Paketi'nin diğer kategorilerini ayrı ayrı kurup istediğiniz ikon kategorisindeki ikonları projenize dahil edebilirsiniz. | ||
|
|
||
| # Kurulum ve Kullanım | ||
|
|
||
| İkon paketini kullanmanın önerilen iki yolu vardır: CDN aracılığı ile dahil etmek ve npm aracılığı ile kurmak. Aşağıda bu iki yöntemi nasıl kullanabileceğiniz anlatılmıştır: | ||
|
|
||
| ## CDN Aracılığıyla Dahil Etmek  | ||
|
|
||
| Paketi, CDN aracılığı ile kullanmak için jsDelivr kullanmanız gerekmektedir. Aşağıdaki CDN bağlantısını kullanabilirsiniz: | ||
|
|
||
| `https://cdn.jsdelivr.net/gh/sci-hook/scicon@latest/style.css` | ||
|
|
||
| Paketi, projenize doğrudan dahil etmek için aşağıdaki kodu kullanabilirsiniz: | ||
|
|
||
| `<link rel="stylesheet" href="https://cdn.jsdelivr.net/gh/sci-hook/scicon@latest/style.css">` | ||
|
|
||
| Yukarıdaki kodu, ikon paketini kullanacağınız dosyanın `<head>` etiketine ekleyebilirsiniz. | ||
|
|
||
| ## npm Aracılığıyla Dahil Etmek  | ||
|
|
||
| Paketi, npm aracılığı ile kurmak için aşağıdaki kodu terminalde çalıştırmalısınız: | ||
|
|
||
| `$ npm i scicon` | ||
|
|
||
| Ardından SCSS dosyanızın içerisine aşağıdaki şekilde ekleyebilirsiniz: | ||
|
|
||
| `@import 'node_modules/scicon';` | ||
|
|
||
| # Dokümantasyon ve Yardım | ||
|
|
||
| Scicon Paketi için daha detaylı dokümantasyon mevcuttur. Kurulum hakkında detaylı bilgilendirme almak, değişiklikleri takip etmek ve sorularınıza cevap almak için lütfen Scicon Paketi'nin GitHub wiki sayfasını inceleyiniz. Wiki sayfasında bulamadığınız cevapları GitHub aracılığı ile issue olarak sorabilirsiniz. Sci-Hook Scion Geliştirme Ekibi size yardımcı olacaktır. | ||
|
|
||
| [Scicon GitHub Wiki Sayfası](https://github.com/Sci-Hook/scicon/wiki) | ||
|
|
||
| [Scicon Github Issues Sayfası](https://github.com/Sci-Hook/scicon/issues) | ||
|
|
||
| # Sürümlendirme   | ||
|
|
||
| Scicon İkon Paketi'ni sürümlendirirken Semantic Sürümlendirmesi ile kendi sürümlendirme sistemimizi birleştirip kullanıyoruz. İkonları şu şekilde sürümlendiriyoruz: | ||
|
|
||
| `<ana-sürüm (major)>.<ikon.güncellemesi (minor)>.<yama (patch)>` | ||
|
|
||
| Ana sürüm, paketin üst sürümüdür ve büyük çaplı değişiklikleri kapsamaktadır. Bu büyük çaplı değişiklikler, yazılımsal değişiklikler ve yeni ikon stilleri gibi önemli güncellemeleri kapsamaktadır. Scicon Paketi'nin ana sürümünü daima güncel tutmanızı öneririz. | ||
|
|
||
| İkon güncellemesi; yeni eklenen, güncellenen ve çıkarılan ikonları kapsamaktadır. Her bir ikon değişikliği için sürüm bir kere artırılır. Örneğin; sürümü 2.0.1 olan paketin yeni sürümünde 5 yeni ikon eklendiyse 3 ikon çıkarıldıysa yeni sürüm, 2.8.1 olacaktır. | ||
|
|
||
| Yamalar; yazılımsal hata düzeltmelerini, yazım hatalarını ve küçük çaplı ikon düzeltmelerini kapsamaktadır. Yamalar, önemli değişiklikleri kapsamamaktadır. Ancak yine de paketin stabil sürümünün kullanılması paketten en iyi verimin alınması için önemlidir. | ||
|
|
||
| # İkon Talebi, Hata Raporlama, Öneriler ve Katkı Sağlama | ||
|
|
||
| Yeni ikon talebinde bulunmak, hataları raporlamak, önerilerinizi sunmak ve paketin gelişmesine katkı sağlamak için GitHub'un issues bölümünü kullanabilirsiniz. Issues bölümü sizi yapmanız gerekenler konusunda yönlendirecektir. Paketin gelişmesine katkı sağlamak istediğiniz için teşekkür ederiz. | ||
|
|
||
| [Scicon Github Issues Sayfası](https://github.com/Sci-Hook/scicon/issues) | ||
|
|
||
| # Katkı Sağlayanlar | ||
|
|
||
| Paketteki ikonların tasarımı ve yazılımsal işleri [Çınar Civan](https://github.com/cinarcivan) tarafından yapılmaktadır. Yazılımsal teknik işler ise [Emirhan Gerçeker](https://github.com/lim10tech) tarafından sürdürülmektedir. | ||
|
|
||
| # Lisans | ||
|
|
||
| Paketteki bütün ikonlar, Creative Commons Attribution-ShareAlike 4.0 International Public (CC BY-SA 4.0) Lisansı altında sunulmaktadır. | ||
|
|
||
| Paketin Scicon fontu, Open Font License (OFL) lisansı altında sunulmaktadır. | ||
|
|
||
| Paketin kaynak kodları MIT, Lisansı altında sunulmaktadır. | ||
|
|
||
| Yasal metni [buradan](https://github.com/Sci-Hook/scicon/blob/main/LICENSE) görüntüleyebilirsiniz. | ||
|
|
||
| # Bu Açıklamayı Başka Dillerde Görüntüleyin | ||
|
|
||
| English (İngilizce): [Click to view this description in English!](https://github.com/Sci-Hook/scicon/blob/main/README.md) |
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| { | ||
| "name": "scicon", | ||
| "version": "1.0.0-alpha.1", | ||
| "description": "CSS Icon Pack by the Sci-Hook Organization", | ||
| "keywords": [ | ||
| "scihook", | ||
| "scicon", | ||
| "scicon-brands", | ||
| "icon-pack", | ||
| "web", | ||
| "font", | ||
| "css-icons" | ||
| ], | ||
| "author": "Çınar Civan", | ||
| "license": "MIT", | ||
| "publisher": "Sci-Hook Organization", | ||
| "homepage": "https://scicon.scihook.org", | ||
| "repository": {"url": "https://github.com/Sci-Hook/scicon-brands"} | ||
| } |