From 55954e9542cb7c8ef3bb1c8e301a3facd50f8914 Mon Sep 17 00:00:00 2001 From: gitee-bot Date: Tue, 9 Sep 2025 03:55:52 +0000 Subject: [PATCH] Add README.md --- README.en.md | 46 ++++++++++++++++++++++++++++++++++++++++++++++ README.md | 52 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 98 insertions(+) create mode 100644 README.en.md create mode 100644 README.md diff --git a/README.en.md b/README.en.md new file mode 100644 index 0000000..84595a6 --- /dev/null +++ b/README.en.md @@ -0,0 +1,46 @@ +# OpenBSD Window Manager Configuration and Themes + +This repository contains configuration files, themes, and assets for WindowMaker and GNUstep on OpenBSD. It includes a variety of icons, background images, and themes that can be used to customize the desktop environment. + +## Features + +- **GNUstep Configurations**: Includes configurations for GNUstep, such as defaults, window attributes, and icons. +- **WindowMaker Themes**: A collection of themes for WindowMaker, including Nord, Travuska, and Ultrafina. +- **Icon Sets**: Contains multiple icon sets, including modern icons, OpenStep icons in various formats (TIFF, XPM), and PNG icons for applications. +- **Background Images**: A set of background images for customizing your desktop. +- **Configuration Scripts**: Shell scripts and configuration files for customizing your environment. + +## Installation + +To use the configurations and themes in this repository, you can clone it into your home directory or system-wide configuration directories. + +### Clone the Repository + +```bash +git clone https://gitee.com/hotalexnet/openbsd.git ~/.openbsd-config +``` + +### Apply Themes and Configurations + +1. **WindowMaker Themes**: Copy the theme files from `GNUstep/Library/WindowMaker/Themes/` to your WindowMaker themes directory. +2. **GNUstep Configs**: Replace or merge the files in `GNUstep/` with your existing GNUstep configuration directory. +3. **Icons**: Replace or merge the icon directories into your icon theme directories. +4. **Backgrounds**: Place background images in your preferred backgrounds directory. + +## Usage + +- Use the WindowMaker settings manager to select themes and icons. +- Customize your environment using the configuration files in `.bashrc`, `.Xresources`, and other dotfiles. +- Apply background images using your desktop environment's settings or a script like `feh` or `nitrogen`. + +## Contributing + +Contributions are welcome! If you have additional themes, icons, or configuration improvements, feel free to submit a pull request. + +## License + +This project is licensed under the terms of the [LICENSE](GNUstep/Defaults/LICENSE) file included in the repository. + +--- + +Please note that this README is a general guide based on the structure of the repository. Specific configurations may vary depending on your system setup and preferences. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..bc6235b --- /dev/null +++ b/README.md @@ -0,0 +1,52 @@ +The project appears to be a collection of configuration files, themes, icons, and other assets for a window manager or desktop environment, likely for OpenBSD. It includes various GNUstep and WindowMaker configurations, icon sets, and theme files. + +Given the structure and contents, here's a general README.md tailored for this project: + +--- + +# OpenBSD Window Manager Configuration and Themes + +This repository contains configuration files, themes, and assets for WindowMaker and GNUstep on OpenBSD. It includes a variety of icons, background images, and themes that can be used to customize the desktop environment. + +## Features + +- **GNUstep Configurations**: Includes configurations for GNUstep, such as defaults, window attributes, and icons. +- **WindowMaker Themes**: A collection of themes for WindowMaker, including Nord, Travuska, and Ultrafina. +- **Icon Sets**: Contains multiple icon sets, including modern icons, OpenStep icons in various formats (TIFF, XPM), and PNG icons for applications. +- **Background Images**: A set of background images for customizing your desktop. +- **Configuration Scripts**: Shell scripts and configuration files for customizing your environment. + +## Installation + +To use the configurations and themes in this repository, you can clone it into your home directory or system-wide configuration directories. + +### Clone the Repository + +```bash +git clone https://gitee.com/hotalexnet/openbsd.git ~/.openbsd-config +``` + +### Apply Themes and Configurations + +1. **WindowMaker Themes**: Copy the theme files from `GNUstep/Library/WindowMaker/Themes/` to your WindowMaker themes directory. +2. **GNUstep Configs**: Replace or merge the files in `GNUstep/` with your existing GNUstep configuration directory. +3. **Icons**: Replace or merge the icon directories into your icon theme directories. +4. **Backgrounds**: Place background images in your preferred backgrounds directory. + +## Usage + +- Use the WindowMaker settings manager to select themes and icons. +- Customize your environment using the configuration files in `.bashrc`, `.Xresources`, and other dotfiles. +- Apply background images using your desktop environment's settings or a script like `feh` or `nitrogen`. + +## Contributing + +Contributions are welcome! If you have additional themes, icons, or configuration improvements, feel free to submit a pull request. + +## License + +This project is licensed under the terms of the [LICENSE](GNUstep/Defaults/LICENSE) file included in the repository. + +--- + +Please note that this README is a general guide based on the structure of the repository. Specific configurations may vary depending on your system setup and preferences. \ No newline at end of file