Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(readme): Linux installers, nixos docs, readme refactor and gruvb… #82

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

iruzo
Copy link

@iruzo iruzo commented Apr 18, 2023

Proposed Changes

  • Trying to reduce size of README and improving readability.
  • Added one click installers for unix/linux as POSIX sh scripts.
  • Documented NixOS installation.
  • Added gruvbox theme (preview webp is still needed).

…ox theme.

1. Added one click installers for unix/linux as POSIX sh scripts.
2. Documented NixOS installation.
3. Fully refactor readme trying to imporve readability trying to reduce
   its size using markdown.
4. Added gruvbox theme.
@unseen-ninja
Copy link
Collaborator

unseen-ninja commented Apr 18, 2023

Ayo! That's a lot. Big thank you for this! <3


Readme

As you have mentioned on Discord; some of these changes are highly objective. Personally I find the readme changes more confusing to read through. Things are also a little bit out of order with the previews just kinda hanging there without being attached to a specific section. o:
And the whole customisation and integration stuff feels a little lost inside all these spoilers.

Oh, and highly personal: I abso-fucking-lutely hate emojis. :D


Gruvbox

The Gruvbox theme is lovely actually! I'll for sure add that one into the mix for the colour schemes. c:


Installer

I also quite like the addition of the installation script, tho if I read that right, there are some issues with it.

First up, the order of changing to the config dir, and removing a potentially pre-existing chrome folder could be swapped to make things a little less convoluted. The default directory may also not always be caught by the regex, I believe? But I'd say that can be omitted.
What I think should def. be there is some sort of warning and check to confirm that an existing chrome folder should be deleted as this might cause unwanted data loss!

Furthermore I'd personally like to have just one installer script that would take arguments for the desired colour scheme to declutter the whole thing a little more. (And maybe even support macOS as well)

I'm happy to look into the changes for the installer script and put them into a separate branch in order for us to make things nice. ^—^

@iruzo iruzo force-pushed the main branch 2 times, most recently from d2ac836 to beb2385 Compare April 19, 2023 20:42
…getting default firefox profile and moving themes to be more accesible from the installer script
@iruzo
Copy link
Author

iruzo commented Apr 19, 2023

Hello @andreasgrafen !, take a look at the changes, there's no need to rush, thank you.

I changed the installer script, so you can pass the theme as parameter (in order to do that, I changed the themes directory from integrations/theme/theme.css to integrations/theme.css).

I also changed the README to move the theming preview to the customization section and removed the emojis, if this doesn't look good enough, I can restore the README to default and just add the doc for gruvbox and the installer.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants