wmclockmon: include sample config-files in dist tar-ball
[dockapps.git] / readme.md
blob9cfae697416c6bace529b310979a653360b21e23
1 # dockapps
3 Dockapps are small tiles that easily fit into a dock in your window manager, but each one could be considered a complete configuration application, amusement, monitoring tool, or a combination of features.
5 Each tile is generally larger than a tray icon but smaller than an application, so they offer a way to do detailed operations while staying out of the way.
7 The instructions below compliment the README file in each app's subdirectory.
9 Generally, you should consult the individual README before running the commands in this file.
11 ## Support
12 (issue reporting, pull request instructions, official links, etc.)
14 The issue tracker is at <https://github.com/window-maker/dockapps/issues>.
15 > However, this repository is just used for the issue tracker and hosting dockapps.net.
16 > The main code is hosted at https://repo.or.cz/dockapps, and patches should be submitted to wmaker-dev@googlegroups.com using git send-email.
18 -[@d-torrance](https://github.com/d-torrance)
21 ## Compile
23 1. If there is no "configure" script but there are autotools input files such as "configure.ac", first run:
24 ```bash
25     autoreconf -fi
26 ```
27 If there is no "configure" script but there is an autogen.sh or autogen file, run that instead:
28 ```bash
29     ./autogen.sh
30     # or ./autogen
31 ```
34 2. @OldCoder says that compiling old C programs requires a special configure command before make:
35 ```bash
36     CFLAGS="-fcommon" bash ./configure
37 ```
39 @Poikilos says:
40 The special configure line above resolves multiple definition errors
41 such as:
42 ```
43 /usr/bin/ld: wmgeneral.o:/home/x/git/dockapps/wmmp3/wmgeneral.h:44: multiple definition of `display'; main.o:/home/x/git/dockapps/wmmp3/wmgeneral.h:44: first defined here
44 ```
45 where /home/x/git/dockapps is the location from which you are compiling.
46 - If you already tried `make` and it failed, you still must run
47   `make clean` before trying `make` again so that the new configure
48   line's fixes will take effect.
51 ```bash
52     make
53 ```
55 ## Install
57 4. Generally, at this point (after doing the Compile steps; or after extracting a release source archive if it contains binaries) you can run:
58 ```bash
59     sudo make install
60 ```
61 unless `make` had errors, or the app's readme has special install instructions.
63 5. If you are using Joe's Window Manager, you can make several
64    dockapps part of a tray. You can make a tray tag directly inside of
65    the JWM tag of ~/.jwmrc, such as via:
66    ```XML
67    <Tray layout="vertical" x="0" y="356" halign="left" width="69">
68         <Swallow width="60" height="62" name="fishmon">wmfishtime</Swallow>
69         <Swallow width="60" height="62" name="wmmp3">wmmp3</Swallow>
70     </Tray>
71 ```
72    (where wmfishtime or wmmp3 is the executable in your system's PATH)
73    - If you aren't sure how to configure Joe's Window Manager
74      but you have jwm installed, you can use the
75      default rc file as a template:
76      ```bash
77     if [ ! -f ~/.jwmrc ]; then
78         cp /etc/jwm/system.jwmrc ~/.jwmrc
79     else
80         echo "$HOME/.jwmrc already exists."
81     fi
82 ```