Tiny Core Extensions > TCE Talk

PicFormat documentation how to

(1/2) > >>

rullolex:
Hi to everyone,

I'm writing a documentation how to for PicFormat that is a command line program that allows us to easily manipulate the resizing, rotation, and format change of images (i. e. from .jpg to .png).

I hope it can be helpfull.

P.s.: this is the first time I write a how to, suggestions are welcome

thank you

Rich:
Hi rullolex
I made the following changes:
1. I reformatted the text to keep the line lengths down to 75 characters or less. You should be able to view the file in
   an 80 character terminal using the  less  command without extra line wrapping occurring:

--- Code: ---less PicFormat-doc.txt
--- End code ---
2. I suspect you had your tabs set to 4 spaces, terminals use 8. I replaced them with 4 spaces.
3. Adjusted grammar in a few sentences.
4. I removed the following section because it goes without saying. This is expected behavior of pretty much all programs:

--- Quote ---NOTE: PicFormat do not require the full path of the image to works if you move into the image folder.
I.e.
PicFormat -i /home/tc/Immagini/prova.jpg -o /home/tc/Immagini/prova.png
and
PicFormat -i prova.jpg -o prova.png

will be the same if you move into the Immagini folder
--- End quote ---

Overall you did a fine job. I doubt I could have done half as good a job translating to Italian.
I attached an updated copy for your review.

rullolex:
Hi Rich,

I wrote that for new users that approach the command line (I don't know that at the beginning because no one learn me)

--- Quote from: Rich on March 29, 2021, 10:57:51 PM ---
4. I removed the following section because it goes without saying. This is expected behavior of pretty much all programs:

--- Quote ---NOTE: PicFormat do not require the full path of the image to works if you move into the image folder.
I.e.
PicFormat -i /home/tc/Immagini/prova.jpg -o /home/tc/Immagini/prova.png
and
PicFormat -i prova.jpg -o prova.png

will be the same if you move into the Immagini folder
--- End quote ---

I will edit my file asap

--- End quote ---

rullolex:
Hi,

after the Rich's suggestions, I  apply some modif, add some note and examples.
I think now it is better.
I attach the english and the italian files
regards

Rich:
Hi rullolex
One tiny spelling mistake:

--- Quote ---the parameter of height of 600 pixels it is enought:
--- End quote ---
There is no  t  in  enough.

I replaced the copy you posted in reply #3 with a corrected copy.

Navigation

[0] Message Index

[#] Next page