https://github.com/elisstaaf/octal
Octal: A subpar LOC counter, written in Go. Contributions are welcome!
https://github.com/elisstaaf/octal
go loc
Last synced: 10 months ago
JSON representation
Octal: A subpar LOC counter, written in Go. Contributions are welcome!
- Host: GitHub
- URL: https://github.com/elisstaaf/octal
- Owner: ElisStaaf
- License: apache-2.0
- Created: 2024-10-29T11:33:42.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-21T21:03:55.000Z (about 1 year ago)
- Last Synced: 2025-01-26T10:30:53.076Z (12 months ago)
- Topics: go, loc
- Language: Go
- Homepage:
- Size: 24.4 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
- License: LICENSE
Awesome Lists containing this project
README
Octal - LOC counter
-------------------
.. image:: https://img.shields.io/badge/Build%20(Fedora)-passing-2a7fd5?logo=fedora&logoColor=2a7fd5&style=for-the-badge
:alt: Build = Passing
:target: https://github.com/ElisStaaf/octal
.. image:: https://img.shields.io/badge/Version-1.0.1-2dd245?style=for-the-badge
:alt: Version = 1.0.1
:target: https://github.com/ElisStaaf/octal
.. image:: https://img.shields.io/badge/Language-Go-20c9df?logo=Go&style=for-the-badge
:alt: Language = Go
:target: https://github.com/ElisStaaf/octal
Octal: A subpar LOC counter, written in Go. But I mean, it works! And you, yes, even *you*, can
use it. Enjoy the project and contributions are welcome!
Requirements
------------
* `go`_
* `make`_
* `git`_ or `gh`_
Install
-------
Firstly, you'd want to install to your computer:
.. code:: bash
# git
git clone https://github.com/ElisStaaf/octal ~/octal
# gh
gh repo clone ElisStaaf/octal ~/octal
Then, you'd want to build the binary to your `/usr/bin`:
.. code:: bash
sudo make install
Then, you're completely free to use it. *BUUUUUUUUUT*, right now it doesn't have support for counting comments, it can
only count empty lines and non-empty lines. |defstrike| \This *will* be fixed soon.\ |endstrike|\ This will *never* be fixed.
I promise.
Usage
-----
.. code:: bash
octal [options]
.. _`go`: https://go.dev/doc/install
.. _`git`: https://git-scm.com/downloads
.. _`gh`: https://github.com/cli/cli#installation
.. _`make`: https://www.gnu.org/software/make
.. |defstrike| raw:: html
.. |endstrike| raw:: html