Merge pull request #275 from snshn/improve-readme-code-snippets

Remove dollar signs from code snippets
This commit is contained in:
Sunshine 2021-07-10 16:40:20 -10:00 committed by GitHub
commit 543bebbd8d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -23,50 +23,74 @@ If compared to saving websites with `wget -mpk`, this tool embeds all assets as
## Installation ## Installation
#### Using [Cargo](https://crates.io/crates/monolith) #### Using [Cargo](https://crates.io/crates/monolith)
$ cargo install monolith ```console
cargo install monolith
```
#### Via [Homebrew](https://formulae.brew.sh/formula/monolith) (macOS and GNU/Linux) #### Via [Homebrew](https://formulae.brew.sh/formula/monolith) (macOS and GNU/Linux)
$ brew install monolith ```console
brew install monolith
```
#### Via [MacPorts](https://ports.macports.org/port/monolith/summary) (macOS)
```console
sudo port install monolith
```
#### Via [MacPorts](https://ports.macports.org/port/monolith/summary) (macOS) #### Via [MacPorts](https://ports.macports.org/port/monolith/summary) (macOS)
$ sudo port install monolith $ sudo port install monolith
#### Using [Snapcraft](https://snapcraft.io/monolith) (GNU/Linux) #### Using [Snapcraft](https://snapcraft.io/monolith) (GNU/Linux)
$ snap install monolith ```console
snap install monolith
```
#### Using [FreeBSD packages](https://svnweb.freebsd.org/ports/head/www/monolith/) (FreeBSD) #### Using [FreeBSD packages](https://svnweb.freebsd.org/ports/head/www/monolith/) (FreeBSD)
$ pkg install monolith ```console
pkg install monolith
```
#### Using [FreeBSD ports](https://www.freshports.org/www/monolith/) (FreeBSD) #### Using [FreeBSD ports](https://www.freshports.org/www/monolith/) (FreeBSD)
$ cd /usr/ports/www/monolith/ ```console
$ make install clean cd /usr/ports/www/monolith/
make install clean
```
#### Using [pkgsrc](https://pkgsrc.se/www/monolith) (NetBSD, OpenBSD, Haiku, etc) #### Using [pkgsrc](https://pkgsrc.se/www/monolith) (NetBSD, OpenBSD, Haiku, etc)
$ cd /usr/pkgsrc/www/monolith ```console
$ make install clean cd /usr/pkgsrc/www/monolith
make install clean
```
#### Using [pre-built binaries](https://github.com/Y2Z/monolith/releases) (Windows, ARM-based devices, etc) #### Using [pre-built binaries](https://github.com/Y2Z/monolith/releases) (Windows, ARM-based devices, etc)
Every release contains pre-built binaries for Windows, GNU/Linux, as well as platforms with non-standart CPU architecture. Every release contains pre-built binaries for Windows, GNU/Linux, as well as platforms with non-standart CPU architecture.
#### Using [containers](https://www.docker.com/) #### Using [containers](https://www.docker.com/)
$ docker build -t Y2Z/monolith . ```console
$ sudo install -b utils/run-in-container.sh /usr/local/bin/monolith docker build -t Y2Z/monolith .
sudo install -b utils/run-in-container.sh /usr/local/bin/monolith
```
#### From source #### From source
Dependency: `libssl-dev` Dependency: `libssl-dev`
$ git clone https://github.com/Y2Z/monolith.git ```console
$ cd monolith git clone https://github.com/Y2Z/monolith.git
$ make install cd monolith
make install
```
--------------------------------------------------- ---------------------------------------------------
## Usage ## Usage
$ monolith https://lyrics.github.io/db/P/Portishead/Dummy/Roads/ -o portishead-roads-lyrics.html ```console
monolith https://lyrics.github.io/db/P/Portishead/Dummy/Roads/ -o portishead-roads-lyrics.html
```
or or
```console
$ cat index.html | monolith -aIiFfcMv -b https://original.site/ - > result.html cat index.html | monolith -aIiFfcMv -b https://original.site/ - > result.html
```
--------------------------------------------------- ---------------------------------------------------