docs: update README to reflect recent repository changes

- Added references to new guides included in the repository.
- Updated paths to server setup notes moved to `setups/*`.
- Reflected overall structural changes and improvements in the repository.

This update ensures the README stays accurate and provides clear navigation for users.
This commit is contained in:
Fabrice Quenneville 2024-12-05 22:36:36 -05:00
parent d57bc2e973
commit a6fa2738cd

View File

@ -13,15 +13,15 @@ This repository is structured into several key directories:
- **notes/**: A collection of markdown files containing notes on various topics, including: - **notes/**: A collection of markdown files containing notes on various topics, including:
- `brother.md`: Information about Brother printers on Linux. - `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. - `btrfs.md`: Btrfs filesystem configuration and tips.
- `chrome-driver.md`: Notes on ChromeDriver setup and usage on Linux.
- `debian packaging.md`: Debian packaging guidelines. - `debian packaging.md`: Debian packaging guidelines.
- `debian_setup_aptly.md`: Comprehensive guide for installing Aptly on Debian. - `dns.md`: DNS configuration and troubleshooting.
- `linux.md`: General Linux tips. - `linux.md`: General Linux tips.
- `pdf.md`: PDF manipulation with Linux command line.
- `pdftk.md`: PDF Toolkit usage.
- `pip packaging.md`: Packaging Python projects with pip. - `pip packaging.md`: Packaging Python projects with pip.
- `ssh.md`: Secure Shell (SSH) configuration and tips.
- **pages/other/**: Templates for other pages, such as the homepage of my Debian package repository. These are provided as inspiration and should not be used as-is. - **pages/other/**: Templates for other pages, such as the homepage of my Debian package repository. These are provided as inspiration and should not be used as-is.
@ -33,6 +33,10 @@ This repository is structured into several key directories:
- **requests/errors/**: Similar to the `pages/errors/` directory, this contains error pages structured as requests for software like HAProxy. - **requests/errors/**: Similar to the `pages/errors/` directory, this contains error pages structured as requests for software like HAProxy.
- **setups/**: A collection of markdown files containing notes on configuring servers, including:
- `debian_setup_aptly.md`: Comprehensive guide for installing Aptly on Debian.
- `debian_setup_gitea.md`: Comprehensive guide for installing Gitea on Debian.
## 📖 Documentation ## 📖 Documentation
Comprehensive documentation will be published at [https://fabquenneville.github.io/script-fabq/](https://fabquenneville.github.io/script-fabq/) but is not available yet. Comprehensive documentation will be published at [https://fabquenneville.github.io/script-fabq/](https://fabquenneville.github.io/script-fabq/) but is not available yet.