diff --git a/README.md b/README.md index 7e1f4309..24a71407 100644 --- a/README.md +++ b/README.md @@ -1,66 +1,19 @@ -# shell-things +# What is this? -This is repository for important files, which I prefer to have everywhere. +This is collection of files which I prefer to have everywhere. -### License +## Where does the name "shell-things" come from? / History -See [LICENSE.md] in this folder. +In the beginning this repository was only GitHub gist and contained only two files, +bashrc. Then I moved to zsh and abandoned .bashrc. Some time after that I got need for +having both files so I merged them into shell-things. At some point there came many +other files from which some aren't related to shells, but I don't want to rename it. -[LICENSE.md]:LICENSE.md +## How do I use this? -## Downloading without git (NEW!) +Just read the files and copy-paste some things which you need. Be aware that there are +things which you want to remove like my name in pastebinit.xml and gpg.conf and .gitconfig and gpg.conf encrypts to me by default etc. -I wrote a script to download files in this repository without git. +## Can I share this -NOTE: If the fourth command gives you "BAD SIGNATURE", proceed with caution! - -``` -wget -O shell-things.sh http://mkaysi.github.com/shell-things.sh -wget -O shell-things.sh.asc http://mkaysi.github.com/shell-things.sh.asc -gpg --fetch-keys http://mkaysi.github.com/PGP/0x82A46728.txt -gpg --verify shell-things.sh.asc -chmod +x shell-things.sh && ./shell-things.sh -``` - -## What is what - -### root - -.cat.sh — script which puts (almost) everything on it's correct place. *WARNING:* It will *overwrite* the current versions of those files if they exist. That is why it's hidden (dot)file. - -.gitignore — list of files, which git shouldn't add to this repository. - -bashrc — [Bourne Again SHell] config file - -gitconfig — [git] config file - -notMkaysi — file which can be pasted to ~/.custom to evade some things, which can be annoyances for others than me. - -pastebinit.xml — [pastebinit] config file - -vimrc — [Vi IMproved] config file - -xsessionrc — what is executed on X logon - -oidentd.conf — configuration file for [Oidentd]. - -tmux.conf — configuration file for [Tmux] terminal multiplexer. - -warnings — script, which suggests Debian packages, which files in this repository think you should have - -zshrc — The [Z SHell] config file - -### gnupg/ — GnuPG related config files - -gpg.conf — [GnuPG] config file - -pgprules.xml.asc — *ENCRYPTED* Enigmail Per-Recepient rules. - -[Bourne Again SHell]:http://tiswww.case.edu/php/chet/bash/bashtop.html -[git]:http://git-scm.com/ -[pastebinit]:http://launchpad.net/pastebinit/ -[Vi IMproved]:http://www.vim.org/ -[Oidentd]:http://ojnk.sourceforge.net/ -[Tmux]:http://tmux.sourceforge.net/ -[Z Shell]:http://www.zsh.org/ -[GnuPG]:http://www.gnupg.org +Yes. If you take something from these files, you can freely redistribute it even without mentioning the source. I am trying to mention original sources in these files.