Skip to content

Add consolidated package manager info to docs #28

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
rolandcrosby wants to merge 1 commit into from
Closed

Add consolidated package manager info to docs #28

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,12 @@ The [releases](https://github.com/PaulJuliusMartinez/jless/releases)
contains links to the latest release. If you have a Rust toolchain
installed, you can build from source by running `cargo install jless`.

JLess is also available via several package managers:
- [Homebrew](https://formulae.brew.sh/formula/jless)
- [MacPorts](https://ports.macports.org/port/jless/)
- [Nix](https://search.nixos.org/packages?channel=unstable&show=jless)
- [NetBSD](https://pkgsrc.se/textproc/jless)

## Logo

The mascot of the `jless` project is Jules the jellyfish.
Expand Down
49 changes: 41 additions & 8 deletions docs/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,11 +70,22 @@
}

.code-snippet.multi .code-block { display: none; }
#mac-install:checked ~ #mac-install-block { display: block; }
#linux-install:checked ~ #linux-install-block { display: block; }

#mac-install:checked ~ div #mac-install-label { background-color: #cacaca; }
#linux-install:checked ~ div #linux-install-label { background-color: #cacaca; }
#mac-install:checked ~ #mac-install-block,
#linux-install:checked ~ #linux-install-block,
#homebrew-install:checked ~ #homebrew-install-block,
#macports-install:checked ~ #macports-install-block,
#nix-install:checked ~ #nix-install-block,
#netbsdport-install:checked ~ #netbsdport-install-block { display: block; }

#mac-install:checked ~ div #mac-install-label,
#linux-install:checked ~ div #linux-install-label,
#homebrew-install:checked ~ div #homebrew-install-label,
#macports-install:checked ~ div #macports-install-label,
#nix-install:checked ~ div #nix-install-label,
#netbsdport-install:checked ~ div #netbsdport-install-label { background-color: #cacaca; }

.code-snippet .tabs { display: flex; }

.code-snippet label {
background-color: #dddddd;
Expand Down Expand Up @@ -171,11 +182,12 @@ <h2>jless — a command-line JSON viewer</h3>
</div>
<h2>Installation</h2>
<p>
The latest JLess releases are available on <a href="https://github.com/PaulJuliusMartinez/jless/releases">GitHub</a>. Jless currently supports macOS and Linux.
macOS and Linux binaries for the latest JLess releases are available on <a href="https://github.com/PaulJuliusMartinez/jless/releases">GitHub</a>.
</p>
<div class="code-snippet multi">
<input type="radio" id="mac-install" name="install" value="mac" style="display: none;" checked="checked">
<input type="radio" id="linux-install" name="install" value="linux" style="display: none;">
<div>
<div class="tabs">
<label id="mac-install-label" for="mac-install">macOS</label>
<label id="linux-install-label" for="linux-install">Linux</label>
</div>
Expand All @@ -186,11 +198,32 @@ <h2>Installation</h2>
<span class="prefix">$ </span>unzip jless-v0.7.1-x86_64-unknown-linux-gnu.zip
<span class="prefix">$ </span>./jless data.json</div>
</div>
<p>
If you have a Rust toolchain installed, you can install directly from source using cargo:
</p>
<div class="code-block"><span class="prefix">$ </span>cargo install jless</div>
<p>
If you have a Rust toolchain installed, you can also install directly from source using cargo:
<div class="code-block"><span class="prefix">$ </span>cargo install jless</div>
JLess is also available via several operating system and standalone package managers:
</p>
<div class="code-snippet multi">
<input type="radio" id="homebrew-install" name="package" value="homebrew" style="display: none;" checked="checked">
<input type="radio" id="macports-install" name="package" value="macports" style="display: none;">
<input type="radio" id="nix-install" name="package" value="nix" style="display: none;">
<input type="radio" id="netbsdport-install" name="package" value="netbsdport" style="display: none;">
<div class="tabs">
<label id="homebrew-install-label" for="homebrew-install">Homebrew</label>
<label id="macports-install-label" for="macports-install">MacPorts</label>
<label id="nix-install-label" for="nix-install">Nix</label>
<label id="netbsdport-install-label" for="netbsdport-install">NetBSD</label>
</div>
<div id="homebrew-install-block" class="code-block"><span class="prefix">$ </span>brew install jless</div>
<div id="macports-install-block" class="code-block"><span class="prefix">$ </span>sudo port install jless</div>
<div id="nix-install-block" class="code-block"><span class="prefix">$ </span>nix run github:PaulJuliusMartinez/jless</div>
<div id="netbsdport-install-block" class="code-block"><span class="prefix">$ </span>pkgin install jless
<span class="prefix"># or, if you prefer to build from source</span>
<span class="prefix">$ </span>cd /usr/pkgsrc/textproc/jless
<span class="prefix">$ </span>make install</div>
</div>
<p>
Check out the <a href="./usage.html">user guide</a> to learn about the full functionality of JLess.
</p>
Expand Down