Eclectic Media Git toast / 1f2b893
Updated the README and added a LICENSE Ariana Giroux 6 months ago
3 changed file(s) with 46 addition(s) and 40 deletion(s). Raw diff Collapse all Expand all
0 Copyright 2019 Ariana Giroux <ariana.giroux@gmail.com>
1
2 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
3
4 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
5
6 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
0 Quickstart guide for toast
1 ==========================
2
3 ``toast`` provides an ease of access layer to BurntToast_ native Windows notifications.
4
5 Installing from Source
6 ======================
7
8 To install from source, first clone the repository_: ::
9
10 git clone git://eclecticmedia.hopto.org/arianagiroux/toast.git; cd toast
11
12 Then, with ``python3`` and ``pip`` installed, install the directory with: ::
13
14 python3 -m pip install .
15
16 *Note: You may need to install the BurntToast_ powershell executable. To do so, run "Install-Module -Name BurntToast" (with administrator privilleges)*
17
18
19 Contributing to the Project
20 ===========================
21
22 We expect to use a git native workflow. Fork the repository, host your fork publicly, and notify the development team that you have changes you would like to merge.
23
24 To do so, add our repository as your upstream: ::
25
26 git remote add upstream git-server:arianagiroux/toast.git
27
28 Obtain ``request-pull`` text: ::
29
30 git request-pull upstream/master origin
31
32 Send that output to the development team at ``ariana.giroux+toast@gmail.com``.
33
34
35 *Note: git-bug is used internally for the project, should we open that up to the public?*
36
37
38 .. _BurntToast: https://github.com/Windos/BurntToast
+0
-40
Readme.rst less more
0 Quickstart guide for toast
1 ==========================
2
3 ``toast`` provides an ease of access layer to BurntToast_ native Windows notifications.
4
5 Installing from Source
6 ======================
7
8 To install from source, first clone the repository_:
9 ::
10
11 git clone git://eclecticmedia.hopto.org/arianagiroux/toast.git; cd toast
12
13 Then, with ``python3`` and ``pip`` installed, install the directory with:
14 ::
15
16 python3 -m pip install .
17
18 .. note:: You may need to install the BurntToast_ powershell executable. To do so, run "Install-Module -Name BurntToast" (with administrator privilleges)
19
20
21 Contributing to the Project
22 ===========================
23
24 We expect to use a git native workflow. Fork the repository, host your fork publicly, and notify the development team that you have changes you would like to merge.
25
26 To do so, add our repository as your upstream:
27 ::
28
29 git remote add upstream git-server:arianagiroux/toast.git
30
31 Obtain ``request-pull`` text:
32 ::
33
34 git request-pull upstream/master origin
35
36 Send that output to the development team.
37
38
39 .. notee:: git-bug is used internally for the project, should we open that up to the public?