Skip to content

Commit 5887624

Browse files
huideyerenhuideyeren
committed
Update Document.
1 parent 6683973 commit 5887624

File tree

1 file changed

+183
-11
lines changed

1 file changed

+183
-11
lines changed

‎README.md‎

Lines changed: 183 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -23,13 +23,142 @@ pip install anshitsu
2323
It is as described in the following help.
2424

2525
``` shell
26-
INFO: Showing help with the command 'anshitsu -- --help'.
2726

27+
28+
29+
30+
31+
32+
33+
34+
35+
36+
37+
38+
NAME
39+
main.py - Process Runnner for Command Line Interface
40+
41+
42+
SYNOPSIS
43+
main.py <flags>
44+
45+
DESCRIPTION
46+
This utility converts the colors of images such as photos.
47+
48+
If you specify a directory path, it will convert
49+
the image files in the specified directory.
50+
If you specify a file path, it will convert the specified file.
51+
If you specify an option, the specified conversion will be performed.
52+
53+
54+
Tosaka mode is a mode that expresses the preference of
55+
Tosaka-senpai, a character in "Kyūkyoku Chōjin R",
56+
for "photos taken with Tri-X that look like they were
57+
burned onto No. 4 or No. 5 photographic paper".
58+
Only use floating-point numbers when using this mode;
59+
numbers around 2.4 will make it look right.
60+
61+
FLAGS
62+
--path=PATH
63+
Type: Optional[Optional]
64+
Default: None
65+
Directory or File Path. Defaults to None.
66+
-k, --keep_alpha=KEEP_ALPHA
67+
Type: bool
68+
Default: False
69+
--colorautoadjust=COLORAUTOADJUST
70+
Type: bool
71+
Default: False
72+
Use colorautoadjust algorithm. Defaults to False.
73+
--colorstretch=COLORSTRETCH
74+
Type: bool
75+
Default: False
76+
Use colorstretch algorithm. Defaults to False.
77+
-g, --grayscale=GRAYSCALE
78+
-g, --grayscale=GRAYSCALE
79+
Type: bool
80+
Default: False
81+
Convert to grayscale. Defaults to False.
82+
-i, --invert=INVERT
83+
Type: bool
84+
Default: False
85+
Invert color. Defaults to False.
86+
--color=COLOR
87+
Type: Optional[Optional]
88+
Default: None
89+
Fix color balance. Defaults to None.
90+
-b, --brightness=BRIGHTNESS
91+
Type: Optional[Optional]
92+
Default: None
93+
Fix brightness. Defaults to None.
94+
--sharpness=SHARPNESS
95+
Type: Optional[Optional]
96+
Default: None
97+
Fix sharpness. Defaults to None.
98+
--contrast=CONTRAST
99+
Type: Optional[Optional]
100+
Default: None
101+
Fix contrast. Defaults to None.
102+
-t, --tosaka=TOSAKA
103+
Type: Optional[Optional]
104+
Default: None
105+
Convert to grayscale with fix contrast. Defaults to None.
106+
Convert to grayscale with fix contrast. Defaults to None.
107+
--outputrgb=OUTPUTRGB
108+
Type: bool
109+
Default: False
110+
Outputs a monochrome image in RGB. Defaults to False.
111+
--sepia=SEPIA
112+
Type: bool
113+
Default: False
114+
Convert to RGB colored by sepia. Defaults to False.
115+
--cyanotype=CYANOTYPE
116+
Type: bool
117+
Default: False
118+
Convert to RGB like cyanotype. Defaults to False.
119+
-n, --noise=NOISE
120+
Type: Optional[Optional]
121+
Default: None
122+
Add Gaussian noise. Defaults to None.
123+
--overwrite=OVERWRITE
124+
Type: bool
125+
Default: False
126+
Default: False
127+
--overwrite=OVERWRITE
128+
Type: Optional[Optional]
129+
Convert to RGB like cyanotype. Defaults to False.
130+
Convert to RGB colored by sepia. Defaults to False.
131+
Default: None
132+
-t, --tosaka=TOSAKA
133+
Default: None
134+
Default: None
135+
--path=PATH
136+
burned onto No. 4 or No. 5 photographic paper".
28137
NAME
29-
anshitsu - Process Runnner for Command Line Interface
138+
main.py - Process Runnner for Command Line Interface
139+
main.py - Process Runnner for Command Line Interface
30140
31141
SYNOPSIS
32-
anshitsu PATH <flags>
142+
SYNOPSIS
143+
main.py <flags>
144+
145+
146+
DESCRIPTION
147+
DESCRIPTION
148+
This utility converts the colors of images such as photos.
149+
150+
If you specify a directory path, it will convert
151+
If you specify a directory path, it will convert
152+
the image files in the specified directory.
153+
the image files in the specified directory.
154+
If you specify a file path, it will convert the specified file.
155+
If you specify an option, the specified conversion will be performed.
156+
157+
NAME
158+
main.py - Process Runnner for Command Line Interface
159+
160+
SYNOPSIS
161+
main.py <flags>
33162
34163
DESCRIPTION
35164
This utility converts the colors of images such as photos.
@@ -52,6 +181,13 @@ POSITIONAL ARGUMENTS
52181
Directory or File Path
53182
54183
FLAGS
184+
--path=PATH
185+
Type: Optional[Optional]
186+
Default: None
187+
Directory or File Path. Defaults to None.
188+
-k, --keep_alpha=KEEP_ALPHA
189+
Type: bool
190+
Default: False
55191
--colorautoadjust=COLORAUTOADJUST
56192
Type: bool
57193
Default: False
@@ -60,29 +196,65 @@ FLAGS
60196
Type: bool
61197
Default: False
62198
Use colorstretch algorithm. Defaults to False.
63-
--grayscale=GRAYSCALE
199+
-g, --grayscale=GRAYSCALE
64200
Type: bool
65201
Default: False
66202
Convert to grayscale. Defaults to False.
67-
--invert=INVERT
203+
-i, --invert=INVERT
68204
Type: bool
69205
Default: False
70206
Invert color. Defaults to False.
71-
--tosaka=TOSAKA
207+
--color=COLOR
208+
Type: Optional[Optional]
209+
Default: None
210+
Fix color balance. Defaults to None.
211+
-b, --brightness=BRIGHTNESS
212+
Type: Optional[Optional]
213+
Default: None
214+
Fix brightness. Defaults to None.
215+
--sharpness=SHARPNESS
216+
Type: Optional[Optional]
217+
Default: None
218+
Fix sharpness. Defaults to None.
219+
--contrast=CONTRAST
72220
Type: Optional[Optional]
73221
Default: None
74-
Use Tosaka mode. Defaults to None.
222+
Fix contrast. Defaults to None.
223+
-t, --tosaka=TOSAKA
224+
Type: Optional[Optional]
225+
Default: None
226+
Convert to grayscale with fix contrast. Defaults to None.
75227
--outputrgb=OUTPUTRGB
76228
Type: bool
77229
Default: False
78230
Outputs a monochrome image in RGB. Defaults to False.
79-
--noise=NOISE
231+
--sepia=SEPIA
232+
Type: bool
233+
Default: False
234+
Convert to RGB colored by sepia. Defaults to False.
235+
--cyanotype=CYANOTYPE
236+
Type: bool
237+
Default: False
238+
Convert to RGB like cyanotype. Defaults to False.
239+
-n, --noise=NOISE
80240
Type: Optional[Optional]
81241
Default: None
82242
Add Gaussian noise. Defaults to None.
83-
84-
NOTES
85-
You can also use flags syntax for POSITIONAL ARGUMENTS
243+
--overwrite=OVERWRITE
244+
Type: bool
245+
Default: False
246+
Overwrite original files. Defaults to False.
247+
-v, --version=VERSION
248+
Type: bool
249+
Default: False
250+
Show version. Defaults to False.
251+
-l, --line_drawing=LINE_DRAWING
252+
Type: bool
253+
Default: False
254+
Convert to like line drawing. Defaults to False.
255+
--posterize=POSTERIZE
256+
Type: Optional[Optional]
257+
Default: None
86258
```
87259
88260
If a directory is specified in the path, an `out` directory will be created in the specified directory, and the converted JPEG and PNG images will be stored in PNG format.

0 commit comments

Comments
 (0)