diff --git a/README.md b/README.md index 0895337..7dca149 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ # Ube -![Latest Release](https://img.shields.io/github/v/release/ramirezfernando/cloc-tool) +![Latest Release](https://img.shields.io/github/v/release/ramirezfernando/ube) ![Coverage](https://img.shields.io/badge/Coverage-82.0%25-brightgreen) -![GitHub Downloads (all assets, all releases)](https://img.shields.io/github/downloads/ramirezfernando/cloc-tool/total) +![GitHub Downloads (all assets, all releases)](https://img.shields.io/github/downloads/ramirezfernando/ube/total) Ube (ooh-bay) is a program that displays statistics about your code. Ube will show the number of files, and total lines within those files grouped by language. -Screen Shot 2024-03-31 at 1 26 14 AM +Ube example ## Table of Contents - [Features](#features) @@ -14,6 +14,7 @@ Ube (ooh-bay) is a program that displays statistics about your code. Ube will sh - [Linux](#linux) - [Windows](#windows) - [Usage](#usage) +- [Common Issues](#common-issues) - [Contributing](#contributing) - [License](#license) @@ -28,62 +29,69 @@ Ube (ooh-bay) is a program that displays statistics about your code. Ube will sh ## Installation ### macOS -1. Download the appropriate release archive for your platform from the [Releases](https://github.com/ramirezfernando/cloc-tool/releases/tag/v1.0.1) page: - - For Intel-based Macs: [cloc-tool_1.0.1_darwin_amd64.tar.gz](https://github.com/ramirezfernando/cloc-tool/releases/download/v1.0.1/cloc-tool_1.0.1_darwin_amd64.tar.gz) - - For Apple Silicon Macs: [cloc-tool_1.0.1_darwin_arm64.tar.gz](https://github.com/ramirezfernando/cloc-tool/releases/download/v1.0.1/cloc-tool_1.0.1_darwin_arm64.tar.gz) +1. Download the appropriate release archive for your platform from the [Latest Release](https://github.com/ramirezfernando/ube/releases/tag/v2.0.0) page: + - For Intel-based Macs: [ube_2.0.0_darwin_amd64.tar.gz](https://github.com/ramirezfernando/ube/releases/download/v2.0.0/ube_2.0.0_darwin_amd64.tar.gz) + - For Apple Silicon Macs: [ube_2.0.0_darwin_arm64.tar.gz](https://github.com/ramirezfernando/ube/releases/download/v2.0.0/ube_2.0.0_darwin_arm64.tar.gz) 2. Extract the archive from your downloads folder using the following command in your terminal: ```bash - $ tar -xzf ~/Downloads/cloc-tool_1.0.1_darwin_amd64.tar.gz # or cloc-tool_1.0.1_darwin_arm64.tar.gz + $ tar -xzf ~/Downloads/ube_2.0.0_darwin_amd64.tar.gz # or ube_2.0.0_darwin_arm64.tar.gz ``` 3. Move the extracted binary to a directory in your PATH for convenient access from any directory: ```bash - $ mv cloc-tool /usr/local/bin/cloc + $ mv ube /usr/local/bin/ube ``` 4. Verify the installation (might have to allow in settings): ``` - $ cloc + $ ube ``` ### Linux -1. Download the appropriate release archive for your platform from the [Releases](https://github.com/ramirezfernando/cloc-tool/releases/tag/v1.0.1) page: - - For 32-bit systems: [cloc-tool_1.0.1_linux_386.tar.gz](https://github.com/ramirezfernando/cloc-tool/releases/download/v1.0.1/cloc-tool_1.0.1_linux_386.tar.gz) - - For 64-bit systems: [cloc-tool_1.0.1_linux_amd64.tar.gz](https://github.com/ramirezfernando/cloc-tool/releases/download/v1.0.1/cloc-tool_1.0.1_linux_amd64.tar.gz) - - For ARM 64-bit systems: [cloc-tool_1.0.1_linux_arm64.tar.gz](https://github.com/ramirezfernando/cloc-tool/releases/download/v1.0.1/cloc-tool_1.0.1_linux_arm64.tar.gz) +1. Download the appropriate release archive for your platform from the [Latest Release](https://github.com/ramirezfernando/ube/releases/tag/v2.0.0) page: + - For 32-bit systems: [ube_2.0.0_linux_386.tar.gz](https://github.com/ramirezfernando/ube/releases/download/v2.0.0/ube_2.0.0_linux_386.tar.gz) + - For 64-bit systems: [ube_2.0.0_linux_amd64.tar.gz](https://github.com/ramirezfernando/ube/releases/download/v2.0.0/ube_2.0.0_linux_amd64.tar.gz) + - For ARM 64-bit systems: [ube_2.0.0_linux_arm64.tar.gz](https://github.com/ramirezfernando/ube/releases/download/v2.0.0/ube_2.0.0_linux_arm64.tar.gz) 2. Extract the archive from your downloads folder using the following command in your terminal: ```bash - $ tar -xzf ~/Downloads/cloc-tool_1.0.1_linux_386.tar.gz + $ tar -xzf ~/Downloads/ube_2.0.0_linux_386.tar.gz # or ube_2.0.0_linux_amd64.tar.gz or ube_2.0.0_linux_arm64.tar.gz ``` 3. Move the extracted binary to a directory in your PATH for convenient access from any directory: ```bash - $ sudo mv cloc-tool /usr/local/bin/cloc + $ sudo mv ube /usr/local/bin/ube ``` 4. Set the correct permissions for the binary: ```bash - $ sudo chmod +x /usr/local/bin/cloc + $ sudo chmod +x /usr/local/bin/ube ``` 5. Verify the installation: ```bash - $ cloc + $ ube ``` ### Windows -1. Download the appropriate release archive for your platform from the [Releases](https://github.com/ramirezfernando/cloc-tool/releases/tag/v1.0.1) page: - - For 32-bit systems: [cloc-tool_1.0.1_windows_386.tar.gz](https://github.com/ramirezfernando/cloc-tool/releases/download/v1.0.1/cloc-tool_1.0.1_windows_386.tar.gz) - - For 64-bit systems: [cloc-tool_1.0.1_windows_amd64.tar.gz](https://github.com/ramirezfernando/cloc-tool/releases/download/v1.0.1/cloc-tool_1.0.1_windows_amd64.tar.gz) - - For ARM 64-bit systems: [cloc-tool_1.0.1_windows_arm64.tar.gz](https://github.com/ramirezfernando/cloc-tool/releases/download/v1.0.1/cloc-tool_1.0.1_windows_arm64.tar.gz) +1. Download the appropriate release archive for your platform from the [Latest Release](https://github.com/ramirezfernando/ube/releases/tag/v2.0.0) page: + - For 32-bit systems: [ube_2.0.0_windows_386.tar.gz](https://github.com/ramirezfernando/ube/releases/download/v2.0.0/ube_2.0.0_windows_386.tar.gz) + - For 64-bit systems: [ube_2.0.0_windows_amd64.tar.gz](https://github.com/ramirezfernando/ube/releases/download/v2.0.0/ube_2.0.0_windows_amd64.tar.gz) + - For ARM 64-bit systems: [ube_2.0.0_windows_arm64.tar.gz](https://github.com/ramirezfernando/ube/releases/download/v2.0.0/ube_2.0.0_windows_arm64.tar.gz) 2. Extract the archive from your downloads folder using a tool like 7-Zip or WinRAR. -3. Move the extracted binary (cloc-tool.exe) to a directory included in your system's PATH environment variable for convenient access, and rename it to cloc.exe. Alternatively, you can run the tool from its extracted location. +3. Move the extracted binary (ube.exe) to a directory included in your system's PATH environment variable for convenient access. Alternatively, you can run the tool from its extracted location. 4. Verify the installation: ``` - $ cloc + $ ube ``` ## Usage ```bash -$ cloc ./your/path +$ ube ./your/path ``` +## Common Issues +### “ube” can’t be opened because Apple cannot check it for malicious software. +1. Naviagte to `Settings` > `Security & Privacy`. +2. Under `General` tab, click "Allow Anyway" next to the message about the app being blocked. +allow anyway + + ## Contributing Contributions are welcome! Please check the [Contributing Guidelines](CONTRIBUTING.md) for a few helpful tips! diff --git a/images/allow-anyway.png b/images/allow-anyway.png new file mode 100644 index 0000000..022b173 Binary files /dev/null and b/images/allow-anyway.png differ