diff --git a/README.md b/README.md index 6ac6501..d5fd69e 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,6 @@ bug.n is a 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 @@ -54,7 +53,6 @@ add-on for Microsoft Windows. It is written in the scripting language * 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 @@ -63,11 +61,17 @@ add-on for Microsoft Windows. It is written in the scripting language * [AutoHotkey](http://ahkscript.org/download/) (if running bug.n from source as a script) -There is no installation process for bug.n. If you downloaded the repository -from [GitHub](https://github.com/fuhsjr00/bug.n/archive/master.zip) 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 -[AutoHotkey](http://ahkscript.org/download/). +You may either +[download the stable version of bug.n](https://github.com/fuhsjr00/bug.n/blob/master/bug.n-stable.zip) +from the repository, or +[download the current development version](https://github.com/fuhsjr00/bug.n/archive/master.zip) +as the repository itself. Either way, you will have a `zip` file including an +executable (`bug.n*.exe`), the source (`src\*`) and documentation (`doc\*`) +files. + +There is no installation process for bug.n. Unpack the `zip` file, and you +should be able to run either the executable as it is or the main script +(`src\Main.ahk`) with [AutoHotkey](http://ahkscript.org/download/). By default bug.n stores the session data (configuration, layout, window states and log) to the user's APPDATA directory, e. g. @@ -79,13 +83,11 @@ 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 diff --git a/bug.n-dev.exe b/bug.n-dev.exe new file mode 100644 index 0000000..3078720 Binary files /dev/null and b/bug.n-dev.exe differ diff --git a/bug.n-stable.zip b/bug.n-stable.zip new file mode 100644 index 0000000..1fd2969 Binary files /dev/null and b/bug.n-stable.zip differ diff --git a/doc/Home.md b/doc/Home.md index 580127b..73d10c8 100644 --- a/doc/Home.md +++ b/doc/Home.md @@ -20,6 +20,15 @@ hotkeys) for each version of bug.n. run bug.n as Administrator to solve problems with the User Access Control of Microsft Windows higher than Vista. +##### [Stable version](../bug.n-stable.zip) +> The current stable version of bug.n as a package (`.zip` file); it includes +the source, a compiled version as one executable and the corresponding +documentation for that version. + +##### [Development version](../bug.n-dev.exe) +> An executable, which was more or less recently compiled from the source of +the current development version of bug.n; please regard the date of the commit. + #### Usage ##### [Using bug.n](./Usage.md) diff --git a/doc/Installing_and_running.md b/doc/Installing_and_running.md index 1397308..bfae17e 100644 --- a/doc/Installing_and_running.md +++ b/doc/Installing_and_running.md @@ -6,11 +6,17 @@ * [AutoHotkey](http://ahkscript.org/download/) (if running bug.n from source as a script) -There is no installation process for bug.n. If you downloaded the repository -from [GitHub](https://github.com/fuhsjr00/bug.n/archive/master.zip) 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 -[AutoHotkey](http://ahkscript.org/download/). +You may either +[download the stable version of bug.n](https://github.com/fuhsjr00/bug.n/blob/master/bug.n-stable.zip) +from the repository, or +[download the current development version](https://github.com/fuhsjr00/bug.n/archive/master.zip) +as the repository itself. Either way, you will have a `zip` file including an +executable (`bug.n*.exe`), the source (`src\*`) and documentation (`doc\*`) +files. + +There is no installation process for bug.n. Unpack the `zip` file, and you +should be able to run either the executable as it is or the main script +(`src\Main.ahk`) with [AutoHotkey](http://ahkscript.org/download/). You may copy bug.n anywhere you like -- at least if you have write acces there -- e. g. `C:\Program Files\bugn` or link it to the 'Windows Start Menu'