Skip to content

Commit c161b25

Browse files
committed
Add README and LICENSE.
1 parent 90efcdc commit c161b25

2 files changed

Lines changed: 49 additions & 0 deletions

File tree

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2020 Mikaël Capelle
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# ModOrganizer2 - Python debug plugin
2+
3+
This is a small plugin built upon [`pyqtconsole`](https://github.com/marcus-oscarsson/pyqtconsole) that
4+
offers a Python interpreter within MO2.
5+
6+
## Installation
7+
8+
To install, go to the [releases](https://github.com/Holt59/modorganizer-python_debug/releases) page and
9+
download the latest release (`python-debug.zip`).
10+
Extract `python-debug.zip` in your MO2 `plugins/python-debug` folder.
11+
12+
## Usage
13+
14+
To start the interpreter, press F12 or use the Tools menu. Within the interpreter, you have access to
15+
the following immediately:
16+
17+
```
18+
mobase # The mobase module
19+
organizer # The global IOrganizer instance
20+
```
21+
22+
## License
23+
24+
MIT License
25+
26+
Copyright (c) 2020 Mikaël Capelle
27+
28+
See [LICENSE](LICENSE) for more information.

0 commit comments

Comments
 (0)