Skip to content
This repository has been archived by the owner on Oct 26, 2023. It is now read-only.

Commit

Permalink
Updates ChangeLog, README and Makefile for packaging a release zip.
Browse files Browse the repository at this point in the history
  • Loading branch information
Richard Bäck committed Sep 13, 2021
1 parent ccf34db commit 19dcc64
Show file tree
Hide file tree
Showing 4 changed files with 52 additions and 11 deletions.
15 changes: 15 additions & 0 deletions ChangeLog.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,18 @@
# Release 0.6

Bugfixes:
* Window tiling was really slow. Some uneccessary Sleep() statements have been removed to gain speed.
* Changing the focused window was unbelievable slow. Also the WIN32 API functions for updating the focused window are not reliable. Actually they do not even allow updating the focused window on the top level. Focusing a window is now performed by a fake mouse click using the WIN32 API.
* Windows created by [Citrix Receiver](https://www.citrix.com/downloads/citrix-receiver/) or [Microsoft Remote Desktop](https://www.microsoft.com/en-us/p/microsoft-remote-desktop/9wzdncrfj3ps?activetab=pivot:overviewtab) were messed up when not floating. This has been fixed.

Features:
* The window tiling implementation has been completely rewritten. It is now almost i3 like.
* Containers can now be split manually by the user..
* Workspaces can now be switched by clicking on the workspace's icon in the b3 bar.

Known bugs:
* Moving a window over to another monitor by direction does not work anymore. This will be fixed in the next release.

# Release 0.5 "Useable" Editon

Bugfixes:
Expand Down
27 changes: 21 additions & 6 deletions Makefile.am
Original file line number Diff line number Diff line change
Expand Up @@ -34,11 +34,26 @@ SUBDIRS = src tests man

EXTRA_DIST = README README.md

CLEANFILES = @PACKAGE_NAME@-@PACKAGE_VERSION@.zip
clean-local: clean-release-zip

release-zip:
zip @PACKAGE_NAME@-@PACKAGE_VERSION@.zip README.md
zip @PACKAGE_NAME@-@PACKAGE_VERSION@.zip ChangeLog.md
zip @PACKAGE_NAME@-@PACKAGE_VERSION@.zip CompatibilityList.md
zip @PACKAGE_NAME@-@PACKAGE_VERSION@.zip -j src/b3.exe
clean-release-zip:
rm -rf @PACKAGE_NAME@-@PACKAGE_VERSION@
rm -rf @PACKAGE_NAME@-@PACKAGE_VERSION@.zip

release-zip: clean-release-zip check
mkdir @PACKAGE_NAME@-@PACKAGE_VERSION@
mkdir @PACKAGE_NAME@-@PACKAGE_VERSION@/bin
mkdir @PACKAGE_NAME@-@PACKAGE_VERSION@/share
mkdir @PACKAGE_NAME@-@PACKAGE_VERSION@/share/man
mkdir @PACKAGE_NAME@-@PACKAGE_VERSION@/share/man/man1

cp README.md @PACKAGE_NAME@-@PACKAGE_VERSION@
cp ChangeLog.md @PACKAGE_NAME@-@PACKAGE_VERSION@
cp CompatibilityList.md @PACKAGE_NAME@-@PACKAGE_VERSION@

cp src/b3.exe @PACKAGE_NAME@-@PACKAGE_VERSION@/bin
cp tests/full.config @PACKAGE_NAME@-@PACKAGE_VERSION@/bin/config

cp man/b3.1 @PACKAGE_NAME@-@PACKAGE_VERSION@/share/man/man1

zip -r @PACKAGE_NAME@-@PACKAGE_VERSION@.zip @PACKAGE_NAME@-@PACKAGE_VERSION@
19 changes: 15 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,16 +47,27 @@ See [here](https://github.com/ritschmaster/b3/blob/master/CompatibilityList.md).

### I need a default configuration

A default config file is included in the [release zip](https://github.com/ritschmaster/b3/releases). There is also an example configuration available at `tests/full.config` (please place it as `config` in the same directory as `b3.exe` to use it).
A default config file is included in the [release zip](https://github.com/ritschmaster/b3/releases). To get started right away, it is already placed as `config` in the same directory as `b3.exe`.

For more information on where the configuration file can be placed please see the included man page. In a release it can be viewed using

man /path/b3/share/man/man1/b3.1
For more information on where the configuration file can be placed please see the included man page.

### Are there known limitations?

Yes, please see [here](https://github.com/ritschmaster/w32bindkeys#are-there-known-limitations).

## Documentation

### User

* In the unzipped release you can perform `man -l man/b3.1` to see the available command line options and where the configuration file can be placed.
* Since b3 tries to be a drop in replacement for i3 you can use [i3 User's Guide](https://i3wm.org/docs/userguide.html) also for b3. But please cross check it with the [compatibility list](https://github.com/ritschmaster/b3/blob/master/CompatibilityList.md).
* b3 releases ship a default configuration file. You can check it to see a list of most used commands.


### Developer

* Currently you have to read the source code entirely to get into b3 development. But most methods/functions have a documentation string. In the future some sort of generated documentation and/or class diagram will be added.

## Compiling

### Dependencies
Expand Down
2 changes: 1 addition & 1 deletion configure.ac
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
# Process this file with autoconf to produce a configure script.

AC_PREREQ([2.69])
AC_INIT([b3], [0.5], [])
AC_INIT([b3], [0.6], [])
AC_CONFIG_SRCDIR([src/])
AC_CONFIG_HEADERS([config.h])
AC_CANONICAL_HOST
Expand Down

0 comments on commit 19dcc64

Please sign in to comment.