Przeglądaj źródła

Merge branch 'master' of https://github.com/gildas-lormeau/SingleFile

Former-commit-id: e77fb74f47aefe29d1896d587088f54c20057eea
Gildas 6 lat temu
rodzic
commit
dc8c507210
1 zmienionych plików z 13 dodań i 25 usunięć
  1. 13 25
      cli/README.MD

+ 13 - 25
cli/README.MD

@@ -6,8 +6,6 @@ SingleFile can be launched from the command line by running it into a (headless)
 
 You can also convert MAFF pages to HTML. For this, you must use specific versions of SingleFile CLI and Firefox. See here for more info: https://github.com/gildas-lormeau/SingleFile-MAFF2HTML.
 
-This is a **work in progress**.
-
 ## Run SingleFile
 
 ### Install
@@ -18,27 +16,27 @@ This is a **work in progress**.
 
 - Unzip the [master archive](https://github.com/gildas-lormeau/SingleFile/archive/master.zip) somewhere on your disk in an empty folder and go into the `SingleFile-master/cli` directory.
 
-  `$ unzip master.zip .`
+  `unzip master.zip .`
   
-  `$ cd SingleFile-master`
+  `cd SingleFile-master`
   
-  `$ cd cli`
+  `cd cli`
   
 - As an alternative to decompressing the master archive, you can clone the repository if `git` is installed on your machine and go into the `SingleFile/cli` directory.
 
-  `$ git clone https://github.com/gildas-lormeau/SingleFile.git`
+  `git clone https://github.com/gildas-lormeau/SingleFile.git`
   
-  `$ cd SingleFile`
+  `cd SingleFile`
   
-  `$ cd cli`
+  `cd cli`
 
 - Install dependencies with npm (installed with Node.js).
 
-  `$ npm install`
+  `npm install`
   
 - Make `single-file` executable (Linux/Unix/BSD etc.).
 
-  `$ chmod +x single-file`
+  `chmod +x single-file`
 
 - To use Firefox instead of Chrome, you must download the [Selenium WebDriver](https://www.npmjs.com/package/selenium-webdriver) component (i.e. `geckodriver` for Firefox).  Make sure it can be found through the `PATH` environment variable or the `cli` folder. Otherwise you will need to set the `--web-driver-executable-path` option to help SingleFile locating the executable.
 
@@ -46,35 +44,25 @@ This is a **work in progress**.
 
 - Syntax
  
-  `$ ./single-file <url> [output] [options ...]` (Linux/Unix/BSD etc.)
-
-  `> single-file <url> [output] [options ...]` (Windows)    
+  `single-file <url> [output] [options ...]`
 
 - Display help
 
-  `$ ./single-file --help` (Linux/Unix/BSD etc.)
-
-  `> single-file --help` (Windows)
+  `./single-file --help`
 
 - Examples
 
   - Dump the processed content of https://www.wikipedia.org into the console
 
-  `$ ./single-file https://www.wikipedia.org` (Linux/Unix/BSD etc.)
-
-  `> single-file https://www.wikipedia.org` (Windows)
+  `./single-file https://www.wikipedia.org`
 
   - Save https://www.wikipedia.org into `wikipedia.html`
 
-  `$ ./single-file https://www.wikipedia.org wikipedia.html` (Linux/Unix/BSD etc.)
-  
-  `> single-file https://www.wikipedia.org wikipedia.html` (Windows)
+  `./single-file https://www.wikipedia.org wikipedia.html`
 
   - Save https://www.wikipedia.org into `wikipedia.html` with Firefox instead of Chrome
 
-  `$ ./single-file https://www.wikipedia.org wikipedia.html --back-end=webdriver-gecko` (Linux/Unix/BSD etc.)
-  
-  `> single-file https://www.wikipedia.org wikipedia.html --back-end=webdriver-gecko` (Windows)
+  `./single-file https://www.wikipedia.org wikipedia.html --back-end=webdriver-gecko`
   
 ## License