From 0a0099d44df479ad8a307c51aa028c24c0d92e9c Mon Sep 17 00:00:00 2001 From: Fabrice Quenneville Date: Wed, 23 Oct 2024 13:56:37 -0400 Subject: [PATCH] Update README: Improve formatting and clarity - Enhanced section headers for improved readability - Added detailed descriptions for setup and usage instructions - Clarified contribution guidelines and project objectives --- README.md | 54 +++++++++++++++++++++++++++++++++++++++++++----------- 1 file changed, 43 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index de7f6c2..8205ed2 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,52 @@ -# scripts-fabq +# ![Fabrice Quenneville' Logo](https://fabq.ca/img/icons/favicon-32x32.webp) scripts-fabq -scripts-fabq is a bash command line tool +**scripts-fabq** is a collection of useful scripts and notes aimed at streamlining command-line operations and improving productivity. This repository is currently incomplete, as I am in the slow process of adding notes and scripts that are stored in closed-source repositories as I revise them. -## Documentation +## 📚 Overview -The documentation is available on the following [link]() +This repository is structured into several key directories: -## Releases +- **scripts/**: Contains individual scripts for various tasks. Currently, it includes: -Instalation instructions are found [here](). + - `video_remove_audio.py`: A script for removing audio from video files. -## Usage +- **notes/**: A collection of markdown files containing notes on various topics, including: -## Contributing -Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. + - `brother.md`: Information about Brother printers on Linux. + - `chrome-driver.md`: Notes on ChromeDriver setup and usage on Linux. + - `dns.md`: DNS configuration and troubleshooting. + - `pdftk.md`: PDF Toolkit usage. + - `ssh.md`: Secure Shell (SSH) configuration and tips. + - `btrfs.md`: Btrfs filesystem configuration and tips. + - `debian packaging.md`: Debian packaging guidelines. + - `linux.md`: General Linux tips. + - `pip packaging.md`: Packaging Python projects with pip. -Please make sure to update tests as appropriate. +- **pages/**: Templates for error pages. These are provided as inspiration and should not be used as-is. -## License +- **requests/**: Similar to the `pages/` directory, this contains error pages structured as requests for software like HAProxy. + +## 📖 Documentation + +Comprehensive documentation will be published at [https://fabquenneville.github.io/script-fabq/](https://fabquenneville.github.io/script-fabq/) but is not available yet. + +## ⚙️ Usage + +To use the scripts, navigate to the `scripts` directory and execute the desired script using Python or Bash. + +**Example for python:** + +```bash +cd scripts +python video_remove_audio.py +``` + +## 🤝 Contributing + +Pull requests are welcome! For major changes, please open an issue first to discuss your ideas. + +Please ensure to update any tests as appropriate. + +## 📜 License + +This project is licensed under the [GNU GPLv3](https://choosealicense.com/licenses/gpl-3.0/)