holm/donovanglover-nix-config
1
0
Fork 0
forked from extern/nix-config
Code Pull Requests Activity
b100d89c64
donovanglover-nix-config/README.md
Donovan Glover b100d89c64
Clean up README.md and add image preview
2017-12-26 21:06:22 -05:00

4.8 KiB
Raw Blame History

New Start

GPLv3 License Creative Commons BY-SA Uses Crystal

Vim is my editor, *nix is my IDE.

Screenshot

New Start is built on top of Arch GNU/Linux and consists of my dotfiles, install scripts, help files, and custom software.

Before You Begin

  1. Linux is not an operating system. All the so-called "Linux" distributions are actually distributions of GNU/Linux.
  2. Arch GNU/Linux is rolling-release. There is no such thing as having to install a new version of Arch.
  3. Free software gives you complete control over your computing. If something doesn't work, it's more often than not user error.
  4. Keep it simple. At the end of the day, you only need to use your computer for a few specific tasks, such as listening to music, writing software, sending messages, and using the internet. Don't overcomplicate things.

This system was built with reproducability in mind. The entire system resolves around being able to install it from scratch and have the exact same configuration as before.

This system is different from your traditional point-click system. There is no such thing as "clicking the close button" here, or clicking anything for that matter.

Once mastered, the interface should not get in the way. Everything just works.

Getting Started

Dotfiles

I know how frustrating it is to see a setup and not have access to the dotfiles. I also know how frustrating it is to go through dotfiles with default config settings everywhere or dotfiles with little to no documentation at all.

My goal here is simple: use as few config settings as possible required to make everything work, and document the settings that I do use. Your "config" file shouldn't be a man page!

Install scripts

The install scripts let you install the entire operating system and dotfiles with a simple command. Note that you should not run this on your actual computer. The install script is meant to be used with the Arch ISO. Simply run:

wget https://raw.githubusercontent.com/GloverDonovan/new-start/master/install.sh
chmod +x install.sh
./install.sh

NOTE: The install script is incomplete and should not be used (yet)!

After installation, you will be able to use the operating system and even put it on a live USB!

Help Files

Help files are a way for me to keep track of all the useful commands I learn about certain software. They're compiled in easy-to-read files so I don't have to search the same thing over and over.

  • commands.md - The majority of terminal commands I use on a daily basis
  • git.md - There's a lot more to Git than you think (no pun intended)
  • gpg.md - Everything you need to know about GPG
  • profanity.md - A primer on using XMPP with Profanity
  • vim.md - A complete reference to everything I know (and find worth mentioning) about vim

Custom Software

This directory holds custom software that I made specifically for my use case. Feel free to use them for inspiration.

Some of the most interesting software include:

  • maid.cr - An easy way to manage dotfiles.
  • theme.cr - Easily change color schemes across everything, including polybar, termite, and i3. Uses base16 color schemes.

Run crystal docs to generate the documentation for these files in a nice format.

Contributing

If you want to improve the help files or other parts of New Start then please file an issue first. Pull requests are accepted, but I'd prefer if you made an issue first!

License

  • Code is released under the GPLv3 license.
  • Help files are released under the Creative Commons BY-SA license.