diff --git a/LICENSE.asciidoc b/LICENSE.md similarity index 94% rename from LICENSE.asciidoc rename to LICENSE.md index b013662..4b2d619 100644 --- a/LICENSE.asciidoc +++ b/LICENSE.md @@ -1,4 +1,4 @@ -= GNU GENERAL PUBLIC LICENSE +## GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007 @@ -7,7 +7,7 @@ Copyright (C) 2007 Free Software Foundation, Inc. Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. -=== Preamble +### Preamble The GNU General Public License is a free, copyleft license for software and other kinds of works. @@ -70,9 +70,9 @@ patents cannot be used to render the program non-free. The precise terms and conditions for copying, distribution and modification follow. -=== TERMS AND CONDITIONS +### TERMS AND CONDITIONS -==== 0. Definitions. +#### 0. Definitions. "This License" refers to version 3 of the GNU General Public License. @@ -111,7 +111,7 @@ work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion. -==== 1. Source Code. +#### 1. Source Code. The "source code" for a work means the preferred form of the work for making modifications to it. "Object code" means any non-source @@ -153,7 +153,7 @@ Source. The Corresponding Source for a work in source code form is that same work. -==== 2. Basic Permissions. +#### 2. Basic Permissions. All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated @@ -178,7 +178,7 @@ Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary. -==== 3. Protecting Users' Legal Rights From Anti-Circumvention Law. +#### 3. Protecting Users' Legal Rights From Anti-Circumvention Law. No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article @@ -194,7 +194,7 @@ modification of the work as a means of enforcing, against the work's users, your or third parties' legal rights to forbid circumvention of technological measures. -==== 4. Conveying Verbatim Copies. +#### 4. Conveying Verbatim Copies. You may convey verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and @@ -207,13 +207,12 @@ recipients a copy of this License along with the Program. You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee. -==== 5. Conveying Modified Source Versions. +#### 5. Conveying Modified Source Versions. You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions: -[none] * a) The work must carry prominent notices stating that you modified it, and giving a relevant date. * b) The work must carry prominent notices stating that it is @@ -242,14 +241,13 @@ beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate. -==== 6. Conveying Non-Source Forms. +#### 6. Conveying Non-Source Forms. You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways: -[none] * a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium @@ -337,7 +335,7 @@ documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying. -==== 7. Additional Terms. +#### 7. Additional Terms. "Additional permissions" are terms that supplement the terms of this License by making exceptions from one or more of its conditions. @@ -359,7 +357,6 @@ Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms: -[none] * a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or * b) Requiring preservation of specified reasonable legal notices or @@ -397,7 +394,7 @@ Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way. -==== 8. Termination. +#### 8. Termination. You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or @@ -425,7 +422,7 @@ this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10. -==== 9. Acceptance Not Required for Having Copies. +#### 9. Acceptance Not Required for Having Copies. You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work @@ -436,7 +433,7 @@ modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so. -==== 10. Automatic Licensing of Downstream Recipients. +#### 10. Automatic Licensing of Downstream Recipients. Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and @@ -461,7 +458,7 @@ rights granted under this License, and you may not initiate litigation any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it. -==== 11. Patents. +#### 11. Patents. A "contributor" is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The @@ -530,7 +527,7 @@ Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law. -==== 12. No Surrender of Others' Freedom. +#### 12. No Surrender of Others' Freedom. If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not @@ -542,7 +539,7 @@ to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program. -==== 13. Use with the GNU Affero General Public License. +#### 13. Use with the GNU Affero General Public License. Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed @@ -553,7 +550,7 @@ but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such. -==== 14. Revised Versions of this License. +#### 14. Revised Versions of this License. The Free Software Foundation may publish revised and/or new versions of the GNU General Public License from time to time. Such new versions will @@ -579,7 +576,7 @@ permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version. -==== 15. Disclaimer of Warranty. +#### 15. Disclaimer of Warranty. THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT @@ -590,7 +587,7 @@ PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. -==== 16. Limitation of Liability. +#### 16. Limitation of Liability. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS @@ -602,7 +599,7 @@ PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. -==== 17. Interpretation of Sections 15 and 16. +#### 17. Interpretation of Sections 15 and 16. If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, @@ -613,7 +610,7 @@ copy of the Program in return for a fee. END OF TERMS AND CONDITIONS -=== How to Apply These Terms to Your New Programs +### How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it @@ -624,37 +621,33 @@ to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. -.... - -Copyright (C) + + Copyright (C) -This program is free software: you can redistribute it and/or modify -it under the terms of the GNU General Public License as published by -the Free Software Foundation, either version 3 of the License, or -(at your option) any later version. + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. -This program is distributed in the hope that it will be useful, -but WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -GNU General Public License for more details. + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. -You should have received a copy of the GNU General Public License -along with this program. If not, see . -.... + You should have received a copy of the GNU General Public License + along with this program. If not, see . Also add information on how to contact you by electronic and paper mail. If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode: -.... - Copyright (C) -This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. -This is free software, and you are welcome to redistribute it -under certain conditions; type `show c' for details. -.... + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. -The hypothetical commands `show w' and `show c' should show the appropriate +The hypothetical commands `show w` and `show c` should show the appropriate parts of the General Public License. Of course, your program's commands might be different; for a GUI interface, you would use an "about box". diff --git a/README.asciidoc b/README.asciidoc deleted file mode 100644 index 8065ab5..0000000 --- a/README.asciidoc +++ /dev/null @@ -1,128 +0,0 @@ -= bug.n -- Tiling Window Manager -Joshua Fuhs, joten - -bug.n is a -https://en.wikipedia.org/wiki/Tiling_window_manager[tiling window manager] -add-on for Microsoft Windows. It is written in the scripting language -http://ahkscript.org/download/[AutoHotkey]. - - -== What it can do - -* Provide layouts for resizing and moving windows, utilizing all available - screen estate and customizable to your specific needs and workflow -* Provide views (i. e. virtual desktops) for showing only those windows, which - you need to do your work. -* Dynamically resize and move your windows, applying a specified layout, - without you having to care about moving them all by mouse -* Increase the available screen estate by hiding and therewith freeing up the - space occupied by -** the Microsoft Windows Taskbar and -** the title bar for every single window -* and replacing all with a single slim status bar (-- but bug.n is not a shell - replacement) -* Show window management information in the status bar: -** active window title -** active layout -** overview of the views used -* Show system information in the status bar: -** time and date -** CPU and memory usage -** disk and network load -** battery level -* Store your settings, i. e. which windows and layout were set on a specific - view -* Support multiple monitors - -== What it enables _you_ to do - -* You can resize and move windows specified by the active layout and - initialized by hotkey. -* You can toggle the visibility of the Windows Taskbar. -* You can toggle the visibility of the Windows title bar of the active window. -* You can change the layout for the tiling window management suitable to your - needs. -** *Tile*: Lay out all windows like tiles on a master area, which can be - further split up, and a stacking area, where remaining windows can be stacked - or shown side by side. -** *Monocle*: All windows are maximized and only one is shown at any time. -** *Floating*: Windows are not dynamically tiled. -* You can further customize the layouts for each view. -* You can move windows to another view (virtual desktop) by tagging them with a - number. -* You can share windows between views by tagging them with more than one - number. -* You can move between views, hiding the windows, you do not want to see, and - showing those, you want to see, by pressing a simple hotkey. - - -== Installing and running bug.n - -*Requirements* - -* Microsoft Windows 2000 or higher - -If running bug.n from source as a script: - -* http://ahkscript.org/download/[AutoHotkey] - -There is no installation wizard for bug.n. If you downloaded the repository -from https://github.com/fuhsjr00/bug.n[GitHub] as a zip file and unpacked it, -you should be able to run either the executbale as it is or the main script -(src\Main.ahk) with http://ahkscript.org/download/[AutoHotkey]. - -bug.n stores the session data (configuration, layout, window states and log) to -the user's APPDATA directory, e. g. C:\Users\joten\AppData\Roaming\bug.n. - -Please see the https://github.com/fuhsjr00/bug.n/tree/master/doc[documentation] -or the https://github.com/fuhsjr00/bug.n/wiki[Wiki] for more information on -installing and running, customizing and using bug.n and for a list of changes -made with the current version, in particular the changes in the user interface -(configuration variables and hotkeys). - - -== License - -bug.n is licensed under the GNU General Public License version 3. Please see -the https://github.com/fuhsjr00/bug.n/blob/master/LICENSE.asciidoc[LICENSE file] -for the full license text. - - -== Credits - -bug.n and its documentation is written by Joshua Fuhs and joten, but some -source was copied from the AutoHotkey forum -(http://www.autohotkey.com/forum). These are explicitly marked in the source -code at the end of the appropriate section. Additionally the following listing -summarizes these sources (of ideas or code): - -=== Patch ideas - -* pitkali (http://pitkali.info/bugn): -** Sync window arrays on fussy events and unknown window ids -** Dialog detection upon manage -** Regular expression support in rules -** Window information handling patches -*** memory leaks -*** flickering windows - -=== Ideas or concepts - -* suckless.org: dwm (http://dwm.suckless.org) -* jgpaiva: GridMove (http://jgpaiva.donationcoders.com/gridmove.html) -* Lexikos: WindowPad - multi-monitor window-moving tool (http://www.autohotkey.com/forum/topic21703.html) - -=== Code snippets - -* fures: System + Network monitor - with net history graph (http://www.autohotkey.com/community/viewtopic.php?p=260329) -* maestrith: Script Writer (http://www.autohotkey.net/~maestrith/Script Writer/) -* PhiLho: AC/Battery status (http://www.autohotkey.com/forum/topic7633.html) -* Pillus: System monitor (HDD/Wired/Wireless) using keyboard LEDs (http://www.autohotkey.com/board/topic/65308-system-monitor-hddwiredwireless-using-keyboard-leds/) -* Sean: -** CPU LoadTimes (http://www.autohotkey.com/forum/topic18913.html) -** Network Download/Upload Meter (http://www.autohotkey.com/community/viewtopic.php?t=18033) -* SKAN: -** Crazy Scripting : Quick Launcher for Portable Apps (http://www.autohotkey.com/forum/topic22398.html) -** HDD Activity Monitoring LED (http://www.autohotkey.com/community/viewtopic.php?p=113890&sid=64d9824fdf252697ff4d5026faba91f8#p113890) -** How to Hook on to Shell to receive its messages? (http://www.autohotkey.com/forum/viewtopic.php?p=123323#123323) -* Unambiguous: Re-use WIN+L as a hotkey in bug.n (http://www.autohotkey.com/community/viewtopic.php?p=500903&sid=eb3c7a119259b4015ff045ef80b94a81#p500903) diff --git a/README.md b/README.md new file mode 100644 index 0000000..4f7fe6f --- /dev/null +++ b/README.md @@ -0,0 +1,126 @@ +## bug.n -- Tiling Window Manager +Joshua Fuhs, joten + +bug.n is a +[tiling window manager](https://en.wikipedia.org/wiki/Tiling_window_manager) +add-on for Microsoft Windows. It is written in the scripting language +[AutoHotkey](http://ahkscript.org/download/). + + +### What it can do + +* Provide layouts for resizing and moving windows, utilizing all available + screen estate and customizable to your specific needs and workflow +* Provide views (i. e. virtual desktops) for showing only those windows, which + you need to do your work. +* Dynamically resize and move your windows, applying a specified layout, + without you having to care about moving them all by mouse +* Increase the available screen estate by hiding and therewith freeing up the + space occupied by + * the Microsoft Windows Taskbar and + * the title bar for every single window +* and replacing all with a single slim status bar (-- but bug.n is not a shell + replacement) +* Show window management information in the status bar: + * active window title + * active layout + * overview of the views used +* Show system information in the status bar: + * time and date + * CPU and memory usage + * disk and network load + * battery level +* Store your settings, i. e. which windows and layout were set on a specific + view +* Support multiple monitors + +### What it enables _you_ to do + +* You can resize and move windows specified by the active layout and + initialized by hotkey. +* You can toggle the visibility of the Windows Taskbar. +* You can toggle the visibility of the Windows title bar of the active window. +* You can change the layout for the tiling window management suitable to your + needs. + * **Tile**: Lay out all windows like tiles on a master area, which can be + further split up, and a stacking area, where remaining windows can be stacked + or shown side by side. + * **Monocle**: All windows are maximized and only one is shown at any time. + * **Floating**: Windows are not dynamically tiled. +* You can further customize the layouts for each view. +* You can move windows to another view (virtual desktop) by tagging them with a + number. +* You can share windows between views by tagging them with more than one + number. +* You can move between views, hiding the windows, you do not want to see, and + showing those, you want to see, by pressing a simple hotkey. + + +### Installing and running bug.n + +#### Requirements + +* Microsoft Windows 2000 or higher + +If running bug.n from source as a script: + +* [AutoHotkey](http://ahkscript.org/download/) + +There is no installation wizard for bug.n. If you downloaded the repository +from https://github.com/fuhsjr00/bug.n[GitHub] as a zip file and unpacked it, +you should be able to run either the executbale as it is or the main script +(src\Main.ahk) with http://ahkscript.org/download/[AutoHotkey]. + +bug.n stores the session data (configuration, layout, window states and log) to +the user's APPDATA directory, e. g. C:\Users\joten\AppData\Roaming\bug.n. + +Please see the [documentation](./doc) or the [Wiki](./wiki) for more +information on installing and running, customizing and using bug.n and for a +list of changes made with the current version, in particular the changes in the +user interface (configuration variables and hotkeys). + + +### License + +bug.n is licensed under the GNU General Public License version 3. Please see +the [LICENSE file](./LICENSE.md) for the full license text. + + +### Credits + +bug.n and its documentation is written by Joshua Fuhs and joten, but some +source was copied from the AutoHotkey forum +(http://www.autohotkey.com/forum). These are explicitly marked in the source +code at the end of the appropriate section. Additionally the following listing +summarizes these sources (of ideas or code): + +#### Patch ideas + +* pitkali (http://pitkali.info/bugn): + * Sync window arrays on fussy events and unknown window ids + * Dialog detection upon manage + * Regular expression support in rules + * Window information handling patches + * memory leaks + * flickering windows + +#### Ideas or concepts + +* suckless.org: [dwm](http://dwm.suckless.org) +* jgpaiva: [GridMove](http://jgpaiva.donationcoders.com/gridmove.html) +* Lexikos: [WindowPad - multi-monitor window-moving tool](http://www.autohotkey.com/forum/topic21703.html) + +#### Code snippets + +* fures: [System + Network monitor - with net history graph](http://www.autohotkey.com/community/viewtopic.php?p=260329) +* maestrith: [Script Writer](http://www.autohotkey.net/~maestrith/Script Writer/) +* PhiLho: [AC/Battery status](http://www.autohotkey.com/forum/topic7633.html) +* Pillus: [System monitor (HDD/Wired/Wireless) using keyboard LEDs](http://www.autohotkey.com/board/topic/65308-system-monitor-hddwiredwireless-using-keyboard-leds/) +* Sean: + * [CPU LoadTimes](http://www.autohotkey.com/forum/topic18913.html) + * [Network Download/Upload Meter](http://www.autohotkey.com/community/viewtopic.php?t=18033) +* SKAN: + * [Crazy Scripting : Quick Launcher for Portable Apps](http://www.autohotkey.com/forum/topic22398.html) + * [HDD Activity Monitoring LED](http://www.autohotkey.com/community/viewtopic.php?p=113890&sid=64d9824fdf252697ff4d5026faba91f8#p113890) + * [How to Hook on to Shell to receive its messages?](http://www.autohotkey.com/forum/viewtopic.php?p=123323#123323) +* Unambiguous: [Re-use WIN+L as a hotkey in bug.n](http://www.autohotkey.com/community/viewtopic.php?p=500903&sid=eb3c7a119259b4015ff045ef80b94a81#p500903) diff --git a/doc/CHANGES.asciidoc b/doc/CHANGES.md similarity index 100% rename from doc/CHANGES.asciidoc rename to doc/CHANGES.md diff --git a/doc/configuration_variables.asciidoc b/doc/configuration_variables.md similarity index 100% rename from doc/configuration_variables.asciidoc rename to doc/configuration_variables.md diff --git a/doc/hotkeys.asciidoc b/doc/hotkeys.md similarity index 100% rename from doc/hotkeys.asciidoc rename to doc/hotkeys.md