Skip to content

Commit

Permalink
Merge pull request owl4ce#2 from selene57/editReadme
Browse files Browse the repository at this point in the history
Fill in README and clean up selene-taffybar cabal file.
  • Loading branch information
selene57 committed Nov 22, 2021
2 parents f33522f + 6c7a463 commit 225f7b9
Show file tree
Hide file tree
Showing 2 changed files with 65 additions and 5 deletions.
64 changes: 62 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,62 @@
# dotfiles
My dotfiles
<p align="center">
<img src="https://raw.githubusercontent.com/selene57/nixfiles/master/images/preview.png" alt="preview"/>
</p>

### Welcome!

This is my latest personal configuration for my unix system.

Here are some of the highlights of my configuration:

- **Operating System**[NixOs w/ Flakes](https://nixos.org/) and with [Home Manager](https://github.com/nix-community/home-manager)
- **Window Manager**[Xmonad](https://xmonad.org/)
- **Compositor**[Picom](https://github.com/yshui/picom)
- **Shell**[Zsh](https://www.zsh.org) :shell: with [oh-my-zsh](https://github.com/ohmyzsh/ohmyzsh) framework!
- **Terminal**[Alacritty](https://github.com/alacritty/alacritty)
- **Bar**[Taffybar](https://github.com/taffybar/taffybar)
- **Notify Daemon**[Dunst](https://github.com/dunst-project/dunst)
- **Application Launcher**[Rofi](https://github.com/davatorium/rofi)
- **File Manager**[Thunar](https://github.com/xfce-mirror/thunar)

## Contents

- [Installation](#installation)
- [NixOs Based Installation](#nixos-based-installation)
- [Changelogs](#changelogs)
- [Known Issues](#known-issues)
- [Acknowledgements](#acknowledgements)
- [License](#license)

## Installation

This installation guide hopes to be informative and clear about how to set up my personal configuration, as well as, any constituient parts, where possible.

### NixOs Based Installation

TODO: Update in the future with detailed instructions.

## Changelogs

This section will be populated in the future, upon each version release.

## Known Issues

- Nvim notes plugin needs to be separately packaged into a .nix file and installed.
- The custom papirus icon theme needs to be installed.
- The .nix system and user files needs to be better partitioned into individual responsibilities.
- The GTK theme needs to be moved over to the owl4ce one by packaging it into a .nix file.
- HTOP needs to be reconfigured.

## Acknowledgements

The following were either major inspirations or direct resources in producing my current configuration. This is not an exhaustive list.

- [owl4ce](https://github.com/owl4ce/dotfiles)
- [Icy-thought](https://github.com/Icy-Thought/Snowflake)
- [Ivan Malison](https://github.com/IvanMalison/dotfiles)

## License

All files in this repository constitute a project, which is free and open source project distributed under the terms of the GNU General Public License, version 3. See the [`LICENSE`](LICENSE) file for details.

When the files are attributed to other sources than this repository, they belong under their sources'respective licenses.
6 changes: 3 additions & 3 deletions config/taffybar/selene-taffybar.cabal
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
name: selene-taffybar
version: 0.1.0.0
synopsis: Selene's TaffyBar configuration.
homepage: https://github.com/Icy-Thought/Snowflake/home/xmonad/icy-taffybar
author: Selene
maintainer: Selene
homepage: https://github.com/selene57/nixfiles/tree/master/config/taffybar
author: Selene Hines
maintainer: Selene Hines
build-type: Simple
cabal-version: >=1.10
data-files: taffybar.css
Expand Down

0 comments on commit 225f7b9

Please sign in to comment.