Added further explanations about usage #5
Conversation
README.md
Outdated
| ``` | ||
| node abp2blocklist.js < easylist.txt > easylist.json | ||
| ``` | ||
|
|
||
| Alternately, the following command can be used in PowerShell, but it results in a larger filesize: |
There was a problem hiding this comment.
Why would this result into a larger file size?
(CC: @mjethani)
There was a problem hiding this comment.
I can't tell for sure, but I could see that while the main command resulted in a ~80kB filesize, the PowerShell-friendly command resulted in a ~150kB filesize despite having the same text contents at first glance.
|
Thanks for taking the time to make the pull request. I'm not sure if the command or extra instructions are necessary though. I just did a test on Windows 10 and was able to use abp2blocklist without any special steps or the
|
|
...Ah. It never really struck me to use node.js's own command prompt system. I am going to make some changes to the pull request to reflect that. Thanks. |
|
If you still find the pull request to be objectionable, I do believe that I've ticked the "Allow edits from maintainers" option, so that you can hopefully edit the pull request to your heart's content. I'm not picky. |
README.md
Outdated
| @@ -34,13 +34,12 @@ generated file by hand. | |||
|
|
|||
| ## Usage | |||
|
|
|||
| In Unix command lines, use: | |||
| We recommend the use of [Node.js](https://nodejs.org/en/download/)'s own command prompt, but it should also work in regular Unix command prompts (e.g. Cygwin). In either case the command is: | |||
There was a problem hiding this comment.
Few people use Windows to run this code, so I don't think we should assume people are running Windows in this documentation, or start off by talking about Windows specific stuff.
There was a problem hiding this comment.
Since some 85-90% of the world runs Windows, and that Abp2blocklist can only be run through a command prompt to the best of my knowledge, I had previously thought that they'd need extra assistance in learning about how to use command prompts in order to use this tool.
It was merely 3 months ago that I was highly confused about how command lines worked like, and I found it difficult to learn how they worked, so I figured that I should create this pull request in general to teach other list maintainers who may currently be in the situation that I was previously in.
README.md
Outdated
| ``` | ||
| node abp2blocklist.js < easylist.txt > easylist.json | ||
| ``` | ||
|
|
||
| Alternately, the following command can be used in PowerShell, but it results in a larger filesize: | ||
|
|
||
| We don't recommend using PowerShell, since it adds bloated metadata that increases the size of the output file, but if so needed, the following command can be used there: |
There was a problem hiding this comment.
If we don't recommend PowerShell why mention it at all or explain how to use it?
|
Duly noted. |
README.md
Outdated
| @@ -34,10 +34,13 @@ generated file by hand. | |||
|
|
|||
| ## Usage | |||
|
|
|||
| In a Unix or Node.js command prompt, use: | |||
There was a problem hiding this comment.
Please can you replace this with "Create a WebKit block list output.json from the Adblock Plus filter list input.txt:"?
README.md
Outdated
| @@ -34,10 +34,13 @@ generated file by hand. | |||
|
|
|||
| ## Usage | |||
|
|
|||
| In a Unix or Node.js command prompt, use: | |||
| ``` | |||
| node abp2blocklist.js < easylist.txt > easylist.json | |||
There was a problem hiding this comment.
Please can you modify this example to use the names input.txt and output.json instead?
README.md
Outdated
| ``` | ||
| node abp2blocklist.js < easylist.txt > easylist.json | ||
| ``` | ||
|
|
||
| This assumes that you're trying to convert an input file that'd be called _easylist.txt_, and that you've navigated to the file's correct folder through the _cd_ command. If the input file has a different name, replace _easylist.txt_ with the file's name. |
There was a problem hiding this comment.
Please can you remove this paragraph entirely?
|
I think there's an assumed level of knowledge about the current working directory and running Node.js with this documentation which means that we don't need to explain about the |
README.md
Outdated
| @@ -34,13 +34,11 @@ generated file by hand. | |||
|
|
|||
| ## Usage | |||
|
|
|||
| In a Unix or Node.js command prompt, use: | |||
| Create a WebKit block list ```output.json``` from the Adblock Plus filter list ```input.txt```: | |||
There was a problem hiding this comment.
Please could you wrap the file names in this sentence in a single backtick instead of three?
|
Thanks this looks good to me (LGTM) now, I'll push it for you shortly. |
|
There you go: 4556506 |
Hello, Dandelion Sprout here.
I've been successfully using this tool to create JSON versions of my Norwegian adblocking list, but it was merely the fruits at the end of my journey about learning how command lines work like, which wasn't necessarily easy peazy for someone who've been used to Windows GUIs for my entire life.
So, in order for me to help theorethical other filterlist maintainers who may not know much about command lines, I decided to suggest adding some extra notes in the Usage section to make it easier for them to properly understand how command lines work, if that's fine with you guys.