Eclectic Media Git dmenu-tweet / 6761474
Added an intial readme and license Ariana Giroux 14 days ago
2 changed file(s) with 66 addition(s) and 0 deletion(s). Raw diff Collapse all Expand all
0 Copyright 2020 Ariana Giroux <ariana.giroux+dmenu-tweet@gmail.com>
1
2 Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
3
4 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
5
6 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
7
8 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
9
10 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
0 # dmenu-tweet
1
2 `dmenu-tweet` is a simple wrapper for [bash-send-tweet] that bridges its functionality with `dmenu`, allowing for a smooth and desktop-agnostic tweeting experience.
3
4 With no browser running in the background, this also allows for execution on much lower end hardware than what might be able to run the website. This is also achieved by ensuring pure bash compliance, meaning 32-bit (and even possibly 16-bit) computers aren't left behind.
5
6 # Installation
7
8 First, you'll need to obtain your Twitter API Keys, a tutorial to which is out of the scope of this document. For more, see [Twitter's Developer page].
9
10 As of `V1`, there is an included setup script (`./setup.sh`) and twitter API key enrollment script (`utils/enroll.sh`) that should be able to handle most of the set-up. It will automatically attempt to install the script (`bin/dmenu-tweet`) to `~/.local/bin/dmenu-tweet` and the `bash-send-tweet` repository to `~/.local/bin/bash-send-tweet`.
11
12 If these directories do not exist and are not on the path (or at least, are not present in ~/.bashrc), the setup script will attempt to handle this automatically.
13
14 If the setup script also detects `i3wm`, it will attempt to add the binding '$mod+Shift+t' to the `~/.config/i3/config` configuration file.
15
16 ## Modifying the installation & manual installation
17
18 If you would rather install the software manually, or to another location, the procedure is fairly simple.
19
20 1. Ensure all git-submodules are up to date:
21
22 `git submodule update --init --recursive`
23
24 2. Enroll your Twitter API Keys:
25
26 `./utils/enroll.sh`
27
28 OR
29
30 Follow the instructions at the beginning of `lib/bash-send-tweet/sendtweet`
31
32 3. Copy the bin script onto your path:
33
34 `cp bin/dmenu-tweet /opt/`
35
36 4. Copy the [bash-send-tweet] repository somewhere useful:
37
38 `cp lib/bash-send-tweet /opt/`
39
40 5. Modify the installed version of `dmenu-tweet`, and update the expected path of [bash-send-tweet] to where you've installed it.
41
42 6. Ensure `dmenu-tweet` is on the path
43
44 7. Optionally, add `bindsym $mod+Shift+t exec --no-startup-id "dmenu-tweet"` somewhere within your `i3` configuration.
45
46 ---
47
48 # Contributing
49
50 Due to the simplicity of the software/wrapper, please submit any bug fixes/patches to `ariana.giroux+dmenu-tweet@gmail.com`. Please refrain from submitting bugs or patches for [bash-send-tweet] to me, as they belong on GitHub!
51
52
53 [bash-send-tweet]: https://github.com/agubelu/bash-send-tweet
54 [twitter's developer page]: https://developer.twitter.com/en