README.md

Friendsum

Yet another lorem ipsum generator. But this one uses Friends quotes instead of sudo-latin. There's a browser-based version in ./website and a Rust CLI version in ./rust.

Quick install

Run this to increase your happiness by at least 4:

wget https://github.com/johnnymatthews/friendsum/releases/download/v1.0.0/friendsum-v1-0-0.tar.gz
sudo tar -xvzf friendsum-v1-0-0.tar.gz -C /usr/local/bin
friendsum 20

Or, you know, just build it yourself

Run locally

If you don't wanna use the live site or the Releases build, you can run things locally:

Serve the website

You can build and run the website locally if you want.

1. Clone this repo:

   git clone https://github.com/johnnymatthews/friendsum

2. Install serve by running one of these commands:

   # NPM
   npm install --global serve

   # PNPM
   pnpm install --global serve

   # Yarn
   yarn install --global serve

3. Start a local server using the ./website directory as the root:

   serve ./website

4. Go to localhost:1313 to view the site.

Build the Rust version

Rust is fun! Build the CLI and run it locally. You'll need Rust installed before you can do these steps:

1. Clone this repo:

   git clone https://github.com/johnnymatthews/friendsum
   cd friendsum

2. Move into the Rust directory:

   cd rust

3. Build using Cargo:

   cargo build

4. Run the friendsum binary you just created:

   ./target/debug/friendsum

5. You can move the friendsum binary to wherever you want, like /usr/local/bin:

   sudo mv ./target/debug/friendsum /usr/local/bin

   Now you can run friendsum ... from anywhere!