Skip to content

Commit d225286

Browse files
committed
Update Changelog and Readme to v2.1.0, fix Changelog format
1 parent 8f23c75 commit d225286

File tree

2 files changed

+204
-41
lines changed

2 files changed

+204
-41
lines changed

CHANGELOG.md

Lines changed: 183 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,102 @@
1-
v2.0.0
2-
===============================================================================
1+
Change Log
2+
================================================================================
3+
4+
All notable changes to the project _Matjaž's dotfiles_ will be documented in
5+
this file. This project adheres to [Semantic Versioning](http://semver.org/).
6+
7+
8+
v2.1.0
9+
----------------------------------------
310

411

5-
Added
12+
### Added
13+
14+
- Aliases:
15+
- `gpg` instead of `gpg2`.
16+
- `weather` forecast.
17+
- `py` instead of `python3`.
18+
- `dot` for the dotfiles directory.
19+
- `pipupgrade` to upgrade all globally installed Python3 packages.
20+
- `traffic` for the LTE quota.
21+
- `filetypes` in a directory recursively.
22+
- [Mac] `httpserve` serve a directory with an HTTP server in python.
23+
- [Mac] `cmdc` and `cmdv` aliases to interact with the clipboard.
24+
- [Mac] `information` about a file, all of it.
25+
- [Mac] `thumbnailize` to create 600px wide thumbnails for my blog.
26+
- [Mac] `htop` instead of `sudo htop`
27+
- New dotfiles:
28+
- For SQLite's command line interface `sqlite`.
29+
- For PostgreSQL command line interface `psql`.
30+
- `ssh` configuration file.
31+
- New function:
32+
- Python virtual enviroment ZSH prompt and function to `activate` it.
33+
- `isodate` and `unixtime` function to quickly get the two most standard
34+
formats, but also to convert them.
35+
- More files for Git to ignore:
36+
- Netbeans.
37+
- C objects.
38+
- LaTeX generated files (except for `pdf`).
39+
- Emacs new settings:
40+
- Spell checking with aspell.
41+
- Better tabbing, untabbing and newline behaviour.
42+
- Backup and auto-save file are created to the `~/.emacs.d/` directory.
43+
- Session restore on Emacs start.
44+
- Open new files in buffers, not frames.
45+
- Deactivate bell sound.
46+
- Ubuntu Server configuration:
47+
- Swapfile creation.
48+
- Hostname setup.
49+
- User setup (adding a user, user's shell).
50+
- Installing an updated Git.
51+
- System locale.
52+
- Oh My Zsh Autojump with the `j` command.
53+
- Update Node.js packages in the `full_system_updater.sh`.
54+
- `mosh` gets installed on all systems.
55+
- [Ubuntu] The installed behaves differently if the user has no root
56+
permissions.
57+
- [Ubuntu] The script catches a SIGINT (CTRL+C)
58+
- [Mac] MacTeX executables added to `$PATH`.
59+
- [Mac] Homebrew formulas are installed with the options they need.
60+
- [Mac] More, more, more Homebrew formulas and fasks.
61+
62+
63+
## Changed
64+
65+
- Prompts are improved: each script has its own so you know what is running.
66+
- Improved `gitignore` function to accept multiple files and show the content
67+
of `.gitignore` if no file is given.
68+
- Default `git push` is set to `simple`.
69+
- ZSH theme has a very cool `r☢☢t` warning when superuser.
70+
- Theme file reorganization.
71+
- Midnight commander's configuration was revisited.
72+
- [Ubuntu] Git gets installed by `apt-get` if does not pre-exists on the
73+
Ubuntu/Debian system.
74+
- [Mac] Updated `psql` alias to PostgreSQL 9.5.
75+
- [Mac] `htop` was updated from v0.8.x to v2.x.x.
76+
77+
78+
## Removed
79+
80+
- [Ubuntu] `apt-get dist-upgrade` was removed, substituted with `upgrade` for
81+
compatibily of the upgraded programs.
82+
83+
84+
## Fixed
85+
86+
- The title sizes in this changelog and the header to make it compatible
87+
with the [Keep a Changelog](http://keepachangelog.com) format.
88+
- Syntax errors in the code.
89+
- [Ubuntu] Wrong `gpg` package name.
90+
- [Ubuntu] `wget` instead of `curl`.
91+
92+
93+
94+
v2.0.0
695
----------------------------------------
796

97+
98+
### Added
99+
8100
- One `git` branch per operative system:
9101
- currently `debian-ubuntu` and `mac-osx`
10102
- removes portability issues of any configuration file or script
@@ -14,28 +106,31 @@ Added
14106
- Explicit license header in every file, except Markdown files
15107

16108

17-
Changed
18-
----------------------------------------
109+
### Changed
19110

20111
- Typo in `LICENSE.md` (missing "the copyright holder")
21112
- Adapted `README.md` to the new branches
22113

23114

24-
Removed
25-
----------------------------------------
115+
### Removed
26116

27117
- Portability of operative-system specific scripts
28118
- Anything except `README.md`, `LICENSE.md` and `CHANGELOG.md` from `master`
29119
branch
120+
30121

122+
### Fixed
123+
124+
Nothing.
31125

32-
v1.2.0
33-
===============================================================================
34126

35127

36-
Added
128+
v1.2.0
37129
----------------------------------------
38130

131+
132+
### Added
133+
39134
- `wget-infinite` and `wget-infinite-status` aliases to start a background
40135
`wget` download that retries from where it stopped until completion
41136
- `gpg` configuration dotfile
@@ -46,24 +141,47 @@ Added
46141
back to `.pdf`. Usually is the best compression without visible quality loss.
47142

48143

49-
Changed
50-
----------------------------------------
144+
### Changed
51145

52146
- OS dependant `mc` alias to start it inside its wrapper, which allows exiting
53147
`mc` in the directory that `mc` was showing
54148
- Update `numerus` alias from Java version of _Numerus_ (_Numerus_) to C version
55149
- Activate tree view in `htop`
56-
- prettier changelog
150+
- Prettier changelog
57151

58152

153+
### Removed
59154

60-
v1.1.1
61-
===============================================================================
155+
Nothing.
156+
157+
158+
### Fixed
62159

160+
Nothing.
63161

64-
Fixed
162+
163+
164+
v1.1.1
65165
----------------------------------------
66166

167+
168+
### Added
169+
170+
Nothing.
171+
172+
173+
### Changed
174+
175+
Nothing.
176+
177+
178+
### Removed
179+
180+
Nothing.
181+
182+
183+
### Fixed
184+
67185
- _Emacs_ installs packages without errors when they are already installed
68186
- Ensured execution of correct _Emacs_ init file
69187
- Portable upgrade of `pip3`, removed errors with permissions
@@ -75,11 +193,10 @@ Fixed
75193

76194

77195
v1.1.0
78-
===============================================================================
196+
----------------------------------------
79197

80198

81-
Added
82-
----------------------------------------
199+
### Added
83200

84201
- Installer interactivity (REPL): offer 8 possible task to choose at run-time to
85202
allow user to perform just some (like only symlinking or git-cloning the
@@ -88,15 +205,43 @@ Added
88205
the packages it needs for the setup (as specified in `emacs_init.el`)
89206
- Improved quality of console output strings
90207

208+
### Changed
91209

210+
Nothing.
92211

93-
v1.0.1
94-
===============================================================================
95212

213+
### Removed
214+
215+
Nothing.
216+
217+
218+
### Fixed
219+
220+
Nothing.
96221

97-
Fixed
222+
223+
224+
v1.0.1
98225
----------------------------------------
99226

227+
228+
### Added
229+
230+
Nothing.
231+
232+
233+
### Changed
234+
235+
Nothing.
236+
237+
238+
### Removed
239+
240+
Nothing.
241+
242+
243+
### Fixed
244+
100245
- Portability fixes:
101246
-`zsh_path` is now portable also on non-OS X systems
102247
- Fix non portable home directory in `zshrc`
@@ -107,11 +252,10 @@ Fixed
107252

108253

109254
v1.0.0
110-
===============================================================================
255+
----------------------------------------
111256

112257

113-
Added
114-
----------------------------------------
258+
### Added
115259

116260
- Dotfiles for:
117261
- Emacs
@@ -130,3 +274,17 @@ Added
130274
- list of mostly useful packages
131275
- license, readme and this changelog
132276

277+
278+
### Changed
279+
280+
Nothing.
281+
282+
283+
### Removed
284+
285+
Nothing.
286+
287+
288+
### Fixed
289+
290+
Nothing.

README.md

Lines changed: 21 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -22,13 +22,13 @@ by `ssh`.
2222
Installation of _Matjaž's dotfiles_
2323
----------------------------------------
2424

25-
This repository has no dotfiles on the master branch but there is **one _Git_
26-
branch for each operative system**. This helps using the OS-specific packager
27-
managers (`apt-get`, `brew`, ...) and make OS-specific changes (for instance
28-
`mc` and `htop` have different configuration files on Linux and OS X).
25+
This repository has no installers and other scripts on the `common` branch but
26+
there is **one _Git_ branch for each operative system**. This helps using the
27+
OS-specific packager managers (`apt-get`, `brew`, ...) and make OS-specific
28+
changes (for instance `htop` has different configurations on Linux and OS X).
2929

3030
**To install _Matjaž's dotfiles_, run one of the following commands**. It
31-
downloads and run the installer for your specific OS found in that OS's branch.
31+
downloads and runs the installer for your specific OS found in that OS's branch.
3232

3333
The installer should handle all the rest with an **interactive command line
3434
interface**. It installs the dotfiles repository (by default in
@@ -43,22 +43,31 @@ _Git_ is required by the installer to clone the branch of your OS.
4343
Basically Linuxes with `apt-get`.
4444

4545
```bash
46+
# Using wget
47+
bash -c "$(wget https://raw.github.com/TheMatjaz/dotfiles/debian-ubuntu/matjaz_dotfiles_installer.sh -O -)"
48+
4649
# Using curl
4750
bash -c "$(curl -fsSL https://raw.github.com/TheMatjaz/dotfiles/debian-ubuntu/matjaz_dotfiles_installer.sh)"
48-
49-
# Or using wget
50-
bash -c "$(wget https://raw.github.com/TheMatjaz/dotfiles/debian-ubuntu/matjaz_dotfiles_installer.sh -O -)"
5151
```
5252

5353

5454
### Apple OS X (Mac)
5555

56+
> **CAUTION!**
57+
> This installer has NEVER BEEN TESTED because I have not yet installed another
58+
> OS X system. Use it at your own risk.
59+
5660
```bash
5761
# Using curl
5862
bash -c "$(curl -fsSL https://raw.github.com/TheMatjaz/dotfiles/mac-osx/matjaz_dotfiles_installer.sh)"
5963
```
6064

6165

66+
### Other OSs
67+
68+
No other OSs yet, but any contribution is welcome!
69+
70+
6271
What is each dotfile for?
6372
----------------------------------------
6473

@@ -71,17 +80,13 @@ What is each dotfile for?
7180
- [`zsh_aliases`](zsh_aliases): custom aliases and functions for the zsh
7281
- [`zsh_fino_custom.zsh-theme`](zsh_fino_custom.zsh-theme): a customized `fino`
7382
theme for _Oh My ZSH!_
74-
- [`gitconfig`](gitconfig): general _Git_ settings
7583
- [`gitignore_global`](gitignore_global): a list of files _Git_ should ignore in
7684
any repository. Those are used also by Mercurial
77-
- [`hgrc`](hgrc): general _Mercurial_ settings
7885
- [`emacs_init.el`](emacs_init.el): _Emacs_ configuration that also installs
7986
some ELPA packages, if not already installed, to completely clone an existing
8087
configuration
81-
- [`htoprc`](htoprc): looks and columns for `htop` process viewer
82-
- [`screenrc`](screenrc): basic settings of `screen` terminal multiplexer
83-
- [`wgetrc`](wgetrc): global configurations of the `wget` command line
84-
downloader
88+
89+
The others are pretty obvious from the filenames alone.
8590

8691

8792
#### Installers/automation scripts
@@ -94,7 +99,7 @@ What is each dotfile for?
9499
_Oh My ZSH!_
95100
- placing the proper symlinks to activate the dotfiles
96101
- performing system updates
97-
- and a few more small things
102+
- and a few more small things such as locale setting, hostname, swapfile
98103
- [`new_system_packages_installer.sh`](new_system_packages_installer.sh)
99104
installs some packages which the Matjaž's dotfiles are for. It calls the
100105
system's package manager. **Can be run stand-alone**. The
@@ -105,7 +110,7 @@ What is each dotfile for?
105110
The `matjaz_dotfiles_installer.sh` calls it optionally during the install.
106111
- [`useful_packages.md`](useful_packages.md) is a simple list containing
107112
packages generally worth installing on any system (it's not an executable,
108-
just a memo).
113+
just a memo). It is not available on the `common` branch.
109114

110115

111116
License

0 commit comments

Comments
 (0)