summaryrefslogtreecommitdiff
path: root/README
blob: 2447d341e2498028a50b43910da8914640eefe34 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
App::papersway
--------------

This is an implementation of PaperWM-like scrollable tiling window management
for Sway/i3wm.  If you like Sway/i3wm's commitments to stability, avoiding
scope creep etc. but dislike the window management model, papersway might be
of interest.

papersway -- PaperWM-like window management using i3-ipc.

papersway-msg -- Script for sending user commands to papersway.

See also:

    https://i3wm.org/
    https://swaywm.org/
    https://github.com/paperwm/PaperWM

    https://material-shell.com/
    https://spatial-shell.app/

INSTALLATION

To install these programs, run the following commands:

    % perl Makefile.PL
    % make
    % make install

If you don't see Makefile.PL, it can be generated from dist.ini using
Dist::Zilla's 'dzil' program.

On Debian 13 or later & Ubuntu 24.10 or later, 'apt-get install papersway'.

SUPPORT AND DOCUMENTATION

After installing, you can find documentation for these programs with
the man command.

    % man papersway

You can also look for information at:

    Project homepage
        https://spwhitton.name/tech/code/papersway/

    RT, CPAN's bug tracker (please see CONTRIBUTING)
        http://rt.cpan.org/NoAuth/Bugs.html?Dist=App-papersway

    MetaCPAN
        https://metacpan.org/release/papersway

COPYRIGHT AND LICENCE

Copyright (C) 2019-2024  Sean Whitton <spwhitton@spwhitton.name>

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.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <https://www.gnu.org/licenses/>.