From da5a56108eb268cb02e8e2a85dd0d3a04ced005e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Carlos=20=C3=81lvaro?= Date: Sun, 10 Mar 2024 17:59:57 +0100 Subject: [PATCH] doc: Update README.md --- README.md | 91 ++++++++++++++++++++++++++++++++++++++----------------- 1 file changed, 64 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index 7288193..3594b6f 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,16 @@ -[![hombrew tap cdalvaro][homebrew_tap_badge]][homebrew_tap_url] - # Homebrew Custom Tap -[@cdalvaro](https://github.com/cdalvaro)'s custom formulae for the [Homebrew package manager](https://brew.sh). -

+[![hombrew tap cdalvaro][homebrew_tap_badge]][homebrew_tap_url] + +[@cdalvaro](https://github.com/cdalvaro)'s custom formulae for the [Homebrew package manager](https://brew.sh). + ## What is this? -This is a [Homebrew tap](https://docs.brew.sh/Taps) containing formulae for software that I use and that is not available in the main Homebrew repositories. +This is a [Homebrew tap](https://docs.brew.sh/Taps) containing formulae for software that I use and that is not available in the main Homebrew repository or has been modified to suit my needs. ## How to enable this tap? @@ -35,7 +35,10 @@ You can directly type `brew install cdalvaro/tap/` to install the speci -#### `catboost-cli` +#### `catboost-cli` + +[![Badge](https://img.shields.io/badge/catboost-catboost-grey?logo=github&color=181717)](https://github.com/catboost/catboost) +[![Badge](https://img.shields.io/badge/Formula-catboost--cli-grey?logo=ruby&color=FBB040&logoColor=CC342D)](Formula/catboost-cli.rb) Fast, scalable, high performance Gradient Boosting on Decision Trees cli tool. @@ -43,9 +46,12 @@ Fast, scalable, high performance Gradient Boosting on Decision Trees cli tool. brew install cdalvaro/tap/catboost-cli ``` -[Formula/catboost-cli.rb](Formula/catboost-cli.rb) +This formula is not available in homebrew-core repository because it does not meet the acceptance criteria. See [Homebrew/homebrew-core#140960](https://github.com/Homebrew/homebrew-core/pull/140960#issuecomment-1704292670) for more information. + +#### `cpp-jwt` -#### `cpp-jwt` +[![Badge](https://img.shields.io/badge/arun11299-cpp--jwt-grey?logo=github&color=181717)](https://github.com/arun11299/cpp-jwt) +[![Badge](https://img.shields.io/badge/Formula-cpp--jwt-grey?logo=ruby&color=FBB040&logoColor=CC342D)](Formula/cpp-jwt.rb) JSON Web Token library for C++. @@ -53,9 +59,12 @@ JSON Web Token library for C++. brew install cdalvaro/tap/cpp-jwt ``` -[Formula/cpp-jwt.rb](Formula/cpp-jwt.rb) +This is a header only C++ library, so it is not available in homebrew-core. But, for convenience, it is available in this tap. -#### `cpp-plotly` +#### `cpp-plotly` + +[![Badge](https://img.shields.io/badge/pablrod-cppplotly-grey?logo=github&color=181717)](https://github.com/pablrod/cppplotly) +[![Badge](https://img.shields.io/badge/Formula-cpp--plotly-grey?logo=ruby&color=FBB040&logoColor=CC342D)](Formula/cpp-plotly.rb) Generate html/javascript charts from C++ data using javascript library plotly.js. @@ -63,9 +72,12 @@ Generate html/javascript charts from C++ data using javascript library plotly.js brew install cdalvaro/tap/cpp-plotly ``` -[Formula/cpp-plotly.rb](Formula/cpp-plotly.rb) +This is a header only C++ library, so it is not available in homebrew-core. But, for convenience, it is available in this tap. + +#### `cpp-zmq` -#### `cpp-zmq` +[![Badge](https://img.shields.io/badge/zeromq-cppzmq-grey?logo=github&color=181717)](https://github.com/zeromq/cppzmq) +[![Badge](https://img.shields.io/badge/Formula-cpp--zmq-grey?logo=ruby&color=FBB040&logoColor=CC342D)](Formula/cpp-zmq.rb) Header-only C++ binding for libzmq. @@ -73,9 +85,12 @@ Header-only C++ binding for libzmq. brew install cdalvaro/tap/cpp-zmq ``` -[Formula/cpp-zmq.rb](Formula/cpp-zmq.rb) +This is a header only C++ library, so it is not available in homebrew-core. But, for convenience, it is available in this tap. + +#### `howard-hinnant-date` -#### `howard-hinnant-date` +[![Badge](https://img.shields.io/badge/HowardHinnant-date-grey?logo=github&color=181717)](https://github.com/HowardHinnant/date) +[![Badge](https://img.shields.io/badge/Formula-howard--hinnant--date-grey?logo=ruby&color=FBB040&logoColor=CC342D)](Formula/howard-hinnant-date.rb) A date and time library based on the C++11/14/17 \ header. @@ -83,9 +98,12 @@ A date and time library based on the C++11/14/17 \ header. brew install cdalvaro/tap/howard-hinnant-date ``` -[Formula/howard-hinnant-date.rb](Formula/howard-hinnant-date.rb) +This formula [is available](https://github.com/Homebrew/homebrew-core/blob/master/Formula/h/howard-hinnant-date.rb) at homebrew-core repository. But I have added the option `--without-string-view` to disable the use of `std::string_view` in the library. This is because `std::string_view` is not available in versions earlier than C++17. -#### `json11` +#### `json11` + +[![Badge](https://img.shields.io/badge/dropbox-json11-grey?logo=github&color=181717)](https://github.com/dropbox/json11) +[![Badge](https://img.shields.io/badge/Formula-json11-grey?logo=ruby&color=FBB040&logoColor=CC342D)](Formula/json11.rb) A tiny JSON library for C++11. @@ -93,9 +111,12 @@ A tiny JSON library for C++11. brew install cdalvaro/tap/json11 ``` -[Formula/json11.rb](Formula/json11.rb) +This is a header only C++ library and the project was archived on March 2020, so it is not available in homebrew-core. + +#### `salt` -#### `salt` +[![Badge](https://img.shields.io/badge/saltstack-salt-grey?logo=github&color=181717)](https://github.com/saltstack/salt) +[![Badge](https://img.shields.io/badge/Formula-salt-grey?logo=ruby&color=FBB040&logoColor=CC342D)](Formula/salt.rb) Software to automate the management and configuration of any infrastructure or application at scale. @@ -103,9 +124,12 @@ Software to automate the management and configuration of any infrastructure or a brew install cdalvaro/tap/salt ``` -[Formula/salt.rb](Formula/salt.rb) +Salt now uses a vendored python, so [it was removed](https://github.com/Homebrew/homebrew-core/pull/157157) from homebrew-core. But I keep it updated for convenience to install it on my Synology NAS. -#### `simple-web-server` +#### `simple-web-server` + +[![Badge](https://img.shields.io/badge/eidheim-Simple--Web--Server-grey?logo=gitlab&color=FC6D26)](https://gitlab.com/eidheim/Simple-Web-Server) +[![Badge](https://img.shields.io/badge/Formula-simple--web--server-grey?logo=ruby&color=FBB040&logoColor=CC342D)](Formula/simple-web-server.rb) A very simple, fast, multithreaded, platform independent HTTP and HTTPS server and client library implemented using C++11 and Boost.Asio. @@ -113,9 +137,10 @@ A very simple, fast, multithreaded, platform independent HTTP and HTTPS server a brew install cdalvaro/tap/simple-web-server ``` -[Formula/simple-web-server.rb](Formula/simple-web-server.rb) +#### `wxwidgets` -#### `wxwidgets` +[![Badge](https://img.shields.io/badge/wxWidgets-wxWidgets-grey?logo=github&color=181717)](https://github.com/wxWidgets/wxWidgets) +[![Badge](https://img.shields.io/badge/Formula-wxwidgets-grey?logo=ruby&color=FBB040&logoColor=CC342D)](Formula/wxwidgets.rb) Cross-Platform GUI Library. @@ -123,7 +148,7 @@ Cross-Platform GUI Library. brew install cdalvaro/tap/wxwidgets ``` -[Formula/wxwidgets.rb](Formula/wxwidgets.rb) +This formula [is available](https://github.com/Homebrew/homebrew-core/blob/master/Formula/w/wxwidgets.rb) at homebrew-core repository. But I have added the option `--with-enable-abort` to allow aborting a running task using a `wxGenericProgressDialog`. ## Available casks @@ -135,7 +160,10 @@ brew install cdalvaro/tap/wxwidgets -#### `autofirma` +#### `autofirma` + +[![Badge](https://img.shields.io/badge/Government%20of%20Spain-autofirma-grey?color=70130B)](https://firmaelectronica.gob.es/Home/Descargas.html) +[![Badge](https://img.shields.io/badge/Cask-autofirma-grey?logo=ruby&color=FBB040&logoColor=CC342D)](Cask/autofirma.rb) Aplicación de firma electrónica desarrollada por el Ministerio de Asuntos Económicos y Transformación Digital. @@ -145,9 +173,12 @@ Al poder ser ejecutada desde el navegador, permite la firma en páginas de Admin brew install --cask cdalvaro/tap/autofirma ``` -[Casks/autofirma.rb](Casks/autofirma.rb) +This cask [is available](https://github.com/Homebrew/homebrew-cask/blob/master/Casks/a/autofirma.rb) at homebrew-cask repository. However, the uninstall postflight script is not working properly, so I haved fixed it in this tap. I tried to fix it in the main repository, but [it was not accepted](https://github.com/Homebrew/homebrew-cask/pull/151676#issuecomment-1687230223). + +#### `salt` -#### `salt` +[![Badge](https://img.shields.io/badge/saltstack-salt-grey?logo=saltproject&color=57BCAD)](https://docs.saltproject.io/salt/install-guide/en/latest/topics/install-by-operating-system/macos.html) +[![Badge](https://img.shields.io/badge/Cask-salt-grey?logo=ruby&color=FBB040&logoColor=CC342D)](Cask/salt.rb) Software to automate the management and configuration of any infrastructure or application at scale. @@ -158,7 +189,13 @@ of building the whole package from source as the formula does. brew install --cask cdalvaro/tap/salt ``` -[Casks/salt.rb](Casks/salt.rb) +This cask [is available](https://github.com/Homebrew/homebrew-cask/blob/master/Casks/s/salt.rb) at homebrew-cask repository. However I have added [a patch](https://github.com/cdalvaro/homebrew-tap/blob/main/Casks/salt.rb#L1-L32) to the `.plist` files to make `salt` to work properly with Homebrew out of the box. + +The patch adds: + +- `HOMEBREW_PREFIX` to the environment. +- `PATH` env variable containing the `HOMEBREW_PREFIX` bin directory. +- `HOME` env variable containing the `root` home directory, to avoid an issue with `brew` command. ## More Documentation