Skip to content

Commit

Permalink
update document
Browse files Browse the repository at this point in the history
  • Loading branch information
LiuJiewenTT committed Jul 1, 2023
1 parent e14043f commit 1c084c4
Show file tree
Hide file tree
Showing 4 changed files with 65 additions and 0 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
keep_local/
60 changes: 60 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,62 @@
# IconFold
A series of tools made for folders' icons. It's aimed to manage the icon used.

This toolkit is made **for Windows** platform.

## Installation
Thers is no need of installation. Just store these things in some place.

There might be some EXE version. (That is, programs being packed into *.exe* files.)

## Using
You should run in some terminal, like *cmd.exe* and *Power Shell*.
> You are ought to run in the location of the programs' directory. Otherwise the *res_ico* would be located at somewhere else.
>
> You may ignore this notice if you are really sure about what you are doing and if it's up to your expectation.
Type "/?" as the only parameter to the program to see help message.

### General Options

| Option | Desc. |
|--------|-------|
| /? | Show help message |
| /S | Do with search. i.e. recursive. |
| /AICO | Affect all icons |

### File Desc.

#### Main programs

| Program | Desc. |
|---------|-------|
| apply_ico | Apply prepared resources the specific folder, or even the subfolders. |
| clean_ico | Clean the *.ini* and the corresponding, or all instead, *.ico* of some folders given. |
| enable_ico | Enable the configuration existed. |
| disable_ico | Disable the configration existed. |

#### Assistant programs

| Program | Desc. |
|---------|-------|
| extract_command | Extract resouce from an already customized folder. |

#### res_ico

Files prepared in *res_ico* and *template_of_res_ico* are **hidden** by default. This is because the files are extracted from a folder customized by the tool of *icofx*.

To show them, change the settings of explorer.

To list the items, execute this command in the cmd (example):
``` shell
dir /A:A res_ico
```

To del the items, execute this command in the cmd (example):
``` shell
del /F /A:A res_ico\*
```

## License

**MIT**
4 changes: 4 additions & 0 deletions src/template_of_res_ico/desktop.ini
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
[.ShellClassInfo]
IconResource=IcoFX_Customization_{BD6C4569-4997-4069-B5D5-4D94BB1213D0}.ico,0
IconFile=IcoFX_Customization_{BD6C4569-4997-4069-B5D5-4D94BB1213D0}.ico
IconIndex=0

0 comments on commit 1c084c4

Please sign in to comment.