Eclectic Media Git toast / c963d27
Updated the README pull/contribution instructions Ariana Giroux 5 months ago
1 changed file(s) with 4 addition(s) and 7 deletion(s). Raw diff Collapse all Expand all
77
88 To install from source, first clone the repository_: ::
99
10 git clone git://eclecticmedia.hopto.org/arianagiroux/toast.git; cd toast
10 git clone git://git.eclecticmedia.space/public/toast.git; cd toast
1111
1212 Then, with ``python3`` and ``pip`` installed, install the directory with: ::
1313
3232 A Note about Compatibility
3333 ==========================
3434
35 It should be noted that this package is initially developed for the Windows Subsystem Layer for Linux, and may have mixed results on native Windows python interpreters. By design, the package only requires that BurntToast_ be on the system path, and callable from the command line with ``$ burnttoast.exe``. Feel free to submit a bug report to ``ariana.giroux+toast@gmail.com`` if you encounter issues. While untested under Windows proper, it should run without issue.
35 It should be noted that this package is initially developed for the Windows Subsystem Layer for Linux, and may have mixed results on native Windows python interpreters. By design, the package only requires that BurntToast_ be on the system path, and callable from the command line with ``$ burnttoast.exe``. Feel free to submit a bug report to ``python-toast-dev@googlegroups.com`` if you encounter issues. While untested under Windows proper, it should run without issue.
3636
3737 Contributing to the Project
3838 ===========================
4141
4242 To do so, add our repository as your upstream: ::
4343
44 git remote add upstream git-server:arianagiroux/toast.git
44 git remote add upstream git://git.eclecticmedia.space/public/toast.git
4545
4646 Obtain ``request-pull`` text: ::
4747
4848 git request-pull upstream/master origin
4949
50 Send that output to the development team at ``ariana.giroux+toast@gmail.com``.
51
52
53 *Note: git-bug is used internally for the project, should we open that up to the public?*
50 Send that output to the maintainers at ``python-toast-dev@googlegroups.com``, where the subject line starts with "PR: ".
5451
5552
5653 .. _BurntToast: https://github.com/Windos/BurntToast