digest-crc

(β˜… 104)

A Cyclic Redundancy Check (CRC) library for Ruby.

  • .gitignore
  • .rspec
  • .yardopts
  • benchmarks.rb
  • ChangeLog.md
  • digest-crc.gemspec
  • Gemfile
  • gemspec.yml
  • LICENSE.txt
  • Rakefile
  • README.md

# Installation Guide

1. Get the code
git clone https://github.com/postmodern/digest-crc

Downloads the entire project code from GitHub to your computer.

cd digest-crc

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • Ruby Ruby is required to use gem.
gem install digest-crc

Installs the package published on RubyGems directly.

βœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Docker

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
⚠️ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
docker build -f spec/integration/docker/Dockerfile.base -t digest-crc .

Builds a runnable image based on the Dockerfile.

docker run -p 8080:80 digest-crc

Runs the built image as an actual container.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

4. Ruby

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Ruby Ruby is required to use the bundle command.
$ bundle exec rake clean

Type this command into your terminal and run it.

$ bundle exec ./benchmarks.rb

Type this command into your terminal and run it.

$ bundle exec rake build:c_exts

Type this command into your terminal and run it.

βœ… If bundle install finishes without errors, continue with the run command from the README (e.g. rails server).

Pulled directly from this repo's README.

// repository documentation