https://github.com/max607/clean-filenames
I experimented with ChatGPT to release a FOSS package. I did this in two hours, so please use with caution.
https://github.com/max607/clean-filenames
Last synced: 11 months ago
JSON representation
I experimented with ChatGPT to release a FOSS package. I did this in two hours, so please use with caution.
- Host: GitHub
- URL: https://github.com/max607/clean-filenames
- Owner: max607
- License: gpl-3.0
- Created: 2023-04-20T17:53:48.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-07-22T11:39:57.000Z (almost 2 years ago)
- Last Synced: 2024-07-22T13:58:05.846Z (almost 2 years ago)
- Language: Shell
- Homepage:
- Size: 22.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Clean Filenames
`clean-filenames` is a command-line tool for renaming files with lowercase names and replacing spaces with hyphens.
## Table of Contents
* [Introduction](#introduction)
* [Installation](#installation)
* [Usage](#usage)
* [Documentation](#documentation)
* [Contributing](#contributing)
* [About ChatGPT](#about-chatgpt)
## Introduction
Clean Filenames is a simple yet powerful tool for renaming files on the command line.
It works by converting all file names to lowercase and replacing any spaces with hyphens.
This makes it easy to work with files on the command line, especially if you're used to working with Unix-like systems.
## Installation
To install `clean-filenames`, simply download the project from GitHub and extract it to a folder on your computer.
You will need to have a Unix-like shell installed (such as Bash) to use the tool.
## Usage
To use `clean-filenames`, simply navigate to the folder containing the files you wish to rename and run the `clean-filenames` script.
By default, the script will rename all files in the current directory and its subdirectories.
For more information on how to use `clean-filenames`, see the Documentation section.
## Documentation
The documentation for `clean-filenames` is included in the doc folder of the project.
This includes a man page for the tool (man/clean-filenames.1).
## Contributing
If you would like to contribute to `clean-filenames`, feel free to fork the project on GitHub and submit a pull request with your changes. All contributions are welcome!
## About ChatGPT
This project was created with the help of ChatGPT, an AI language model created by OpenAI.
ChatGPT was used to guide every aspect of the project, including making the release, instructions on making a man page and helping the coding.