Browse Source

update readme for current status

main
Brennen Bearnes 3 months ago
parent
commit
0e3222c7a6
1 changed files with 31 additions and 29 deletions
  1. +31
    -29
      README.md

+ 31
- 29
README.md View File

@ -5,14 +5,13 @@ bpb-kit
This repo is for dotfiles, utility scripts, and other things in my personal
setup. Ideally, it includes most of the bits and pieces that make a personal
machine usable for me. It may occasionally serve as a testbed for things that
will eventually become standalone projects, or get cycled into stuff I do for a
living.
I generally use Debian and Debian-like GNU/Linux systems (including Ubuntu),
with the [xmonad][xmonad] tiling window manager rather than a full desktop
environment like Gnome or KDE. I usually edit text in Vim, with
[VimWiki][vimwiki] for notes. I maintain a blog called [p1k3][p1k3] using
machine usable for me. It occasionally serves as a testbed for things that
become standalone projects, or get cycled into stuff I do for a living.
I generally use Debian and Debian-like GNU/Linux systems (sometimes including
Ubuntu), with the [xmonad][xmonad] tiling window manager rather than a full
desktop environment like Gnome or KDE. I usually edit text in Vim, with
[VimWiki][vimwiki] for notes. I maintain a website called [p1k3][p1k3] using
[wrt][wrt].
I have a [partially-finished book about the command line][userland] which may
@ -21,9 +20,9 @@ be relevant.
status
------
As of March 2021, this collection is actively maintained, although it
doesn't meet the standards of quality, consistency, or documentation you might
want from a real software project.
As of March 2022, this collection is actively maintained, although it doesn't
meet the standards of quality, consistency, or documentation you'd want from a
real software project.
(Then again, neither do most software projects.)
@ -37,19 +36,17 @@ neighboring rights to the contents of bpb-kit. Go to town.
a philosophical note about copying
----------------------------------
In the _general case_, I'm a proponent of Free Software, and correspondingly of
the pragmatic value of strong copyleft licenses like the GNU General Public
License. Where I have the option, I'll generally license more substantial
projects under the GPL, with a view towards impeding the corporate capture of
every available computational resource and generally throwing a little grit in
the gears of capital in these latter days before it finishes murdering the
entire biosphere. (As no one uses my software, this is a purely symbolic
gesture, but what the hell.)
In the _general case_, I've long been a proponent of Free Software, and I've
tended to use strong copyleft licenses like the GNU General Public License.
Where I have the option, I'll generally license more substantial projects with
a view towards impeding the corporate capture of every available computational
resource and generally throwing a little grit in the gears of capital in these
latter days before it finishes murdering the entire biosphere. (No one uses
my software, so this is a purely symbolic gesture.)
All that said, this is a trivial repository of configuration fragments and
small utility scripts for a very limited audience. It seems likely to do the
most good if nobody has to worry about the bureaucracy of grabbing bits and
pieces of it.
utility scripts for a limited audience. It will do the most good if nobody has
to worry about the bureaucracy of grabbing bits and pieces of it.
From time to time, I _may_ incorporate code from other sources in this
collection, as long as it's in the public domain or under a license that meets
@ -62,7 +59,6 @@ sources
I have thiefed ideas and fragments of configuration from, at least, the
following projects:
- [Advanced Bash Scripting Guide][bash-guide], Mendel Cooper
- [Learn Vimscript the Hard Way][vimscript], Steve Losh
- [ArchWiki][archwiki]
@ -102,8 +98,8 @@ etc.
At this writing I use ZSH on personal systems and Bash when writing tutorials,
doing tech support, or working on production server systems. I like to keep
lots and lots of history. I think shell scripting is a nightmare for most real
tasks, but I do it pretty often anyway.
lots and lots of history. I think shell scripting is in many ways a nightmare
for programs longer than a few lines, but I do it pretty often anyway.
- [`.bashrc`](home/.bashrc)
- [`.zshrc`](home/.zshrc) - nothing fancy
@ -117,10 +113,12 @@ Scripts here fall into a handful of categories:
- Short wrappers for getting (or remembering) specific behavior from other
tools
- Screenshot and screencast tools used in my work as a writer for
DigitalOcean and Adafruit
- Screenshot and screencast tools, used at one time in my work as a writer
for DigitalOcean and Adafruit and kept because I got used to the
convenience
- Things for working with the [p1k3][p1k3] repo and site
- Text filters and template fragments, mostly for use with Vim aliases
- Stuff I use for working with my personal notes
- Miscellaneous utilities
Many of these are unlikely to be portable, useful, or documented.
@ -183,7 +181,7 @@ automatically extracted.
The [fragments](home/fragments) directory is for code snippets that I write in the
course of testing some idea, checking a technique, or trying to solve a problem
posed by friends on IRC.
posed by friends.
They're typically the kind of thing I'd throw in a random file called something
like `test.sh` and overwrite later. It seemed useful to start collecting these
@ -212,13 +210,17 @@ snippet for correcting weird Esc-key behavior in Vim.
### vim config
My Vim setup was once written to be easily copied by new users. It's gotten a
little out of hand since then.
out of hand since then.
- [`.vimrc`](home/.vimrc) - see file for installation details
- uses [Vundle][vundle] to manage plugins and such
- pulls in a ton of plugins, some more useful than others
- has a bunch of customization for [VimWiki][vimwiki]
I don't use Neovim because I've never gotten it to work for my config without
serious glitches. (At this writing, I had last made a serious attempt in late
2021.)
### window management
- `.xmodmap`


Loading…
Cancel
Save