DiegoMagdaleno / BSDCoreUtils

The *BSD utils project

This project is a GNU coreutils-like collection of utilities from diverse BSD operating systems (FreeBSD, OpenBSD and NetBSD). The intent is to offer a BSD-licensed and lightweight replacement for the GNU coreutils project.

Table of notes

• Installation
• Contributing

Installation

Here are some instructions to get this collection of tools running on your computer!

Option 1 - Precompiled bin:

If you don't wish to compile, there is a precompiled bin option, for the macOS operating system.

In order to achieve this, just follow these instructions:

1. Install Homebrew for macOS.
2. Go to your terminal, and execute the following command brew tap diegomagdaleno/homebrew-diegoutils
3. Now run brew install bsd-coreutils

Note: These tools will be installed with the "b" prefix, for example "bcat" instead of "cat".

Note 2: BSDCoreutils precompiled bins will be available for diverse Linux distributions eventually

Option 2 - From source:

Building from source is a recommended option if you want to read and wish to take control over what you install on your computer.

1. Make sure you have openssl installed, including development libraries (Header files, etc)³
2. Make sure you have the CMake toolchain installed (Google how to install it for your operating system)
3. Open your terminal, and cd in to the directory where you cloned/downloaded.
4. Run mkdir build && cd build
5. Run cmake ..
6. Run make

3. This is only required on Linux based operating systems, on macOS the native implementation of the hashing algorithms will be used

Contributing

Contributions are welcome and encouraged.

If you would like to contribute please do the following:

• Contributing code:

  If you decide to contribute to this project, here are the instructions to get you started ^_^

  It is recommened that you contribute fixes to tools, or other tools from other BSD Systems, make sure they are under the BSD license.

  1. Fork this repository
  2. Git clone your fork into your computer
  3. Hack it and have fun.
  4. Push and submit a pull request!

• Contributing ideas and requests:

  If you like and enjoy this collection of tools, but however, you think something is missing feel free to recommend it like this:

  1. Open a new GitHub issue
  2. Submit with a good explanation what your feature should do
  3. Be patient, I do this in my free time

  Some notes: Please don't ask for features that break our BSD mindset like the inclusion of --long-flags

• Contributing love and fun:

  Sure you can, if you really enjoy this collection of utilities, you can send me an email or tweet, saying how it helps you, it means a lot.

  However, in this case, I think is our friend David Cantrell that deserves your love and credit, he did all of the hardwork to make this beatiful set of tools possible.