Skip to content

Commit

Permalink
- Add development files
Browse files Browse the repository at this point in the history
- Update README with fixes for installation instructions and issues/feedback
  • Loading branch information
Zach Zahos committed May 24, 2023
1 parent b34c970 commit 63c0b94
Show file tree
Hide file tree
Showing 5 changed files with 49 additions and 10 deletions.
4 changes: 1 addition & 3 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,4 @@ stdeo.txt
PyMS/WORKING/*
PyMS/Logs/*
playground.py
**/__pycache__
.vscode/*
.python-version
**/__pycache__
1 change: 1 addition & 0 deletions .python-version
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
2.7.16
15 changes: 15 additions & 0 deletions .vscode/launch.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
{
// Use IntelliSense to learn about possible attributes.
// Hover to view descriptions of existing attributes.
// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
"version": "0.2.0",
"configurations": [
{
"name": "Python: Current File",
"type": "python",
"request": "launch",
"program": "${file}",
"console": "integratedTerminal"
}
]
}
24 changes: 24 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
{
"python.pythonPath": "~/.pyenv/versions/2.7.16/bin/python2.7",

"python.analysis.autoImportCompletions": false,

"python.linting.enabled": true,
"python.linting.pylintEnabled": true,
"python.linting.pylintArgs": [
"--disable=all",
"--enable=F,E,unreachable,duplicate-key,unnecessary-semicolon,global-variable-not-assigned,unused-variable,binary-op-exception,bad-format-string,anomalous-backslash-in-string,bad-open-mode",
"--disable=print-statement"
],

"python.testing.unittestArgs": [
"-v",
"-s",
".",
"-p",
"test_*.py"
],
"python.testing.pytestEnabled": false,
"python.testing.unittestEnabled": true,
"python.linting.mypyEnabled": false,
}
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,19 +27,20 @@ PyMS is a cross platform BroodWar modding suite written using [Python](http://ww
1. **Install Python.** You should get the latest Python 2.7.x, currently that is [Python 2.7.12](https://www.python.org/downloads/release/python-2712/)

**Note:** On Windows, you must ensure that Python is in your "Path" environment variable. If you use the MSI Installer there is an "Add Python.exe to path" option you should make sure is enabled during installation, otherwise you can [set it up manually](https://docs.python.org/2.7/using/windows.html#excursus-setting-environment-variables).
2. **Install Dependencies.** Use PIP (the Python package manager), to install all dependencies of PyMS by opening the command line, navigating to the PyMS folder, and running `python2.7 -m pip install -r requirements.txt`
3. **Download PyMS.** Always get the most up to date PyMS from [github](https://github.com/poiuyqwert/pyms) ([direct link](https://github.com/poiuyqwert/PyMS/archive/master.zip)). If you are updating PyMS, you can keep your settings files located in the Settings folder.
2. **Download PyMS.** Always get the most up to date PyMS from [github](https://github.com/poiuyqwert/pyms) ([direct link](https://github.com/poiuyqwert/PyMS/archive/master.zip)). If you are updating PyMS, you can keep your settings files located in the Settings folder.
3. **Install Dependencies.** Use PIP (the Python package manager), to install all dependencies of PyMS by opening the command line, navigating to the PyMS folder, and running `python2.7 -m pip install -r requirements.txt`. If you get an error like `python2.7 is not found`, try `python -m pip install -r requirements.txt` (just make sure you are using PIP that is installed with Python 2.7 and not another verson of Python on your machine).

## Issues/Feedback
If you run into any issues with the programs, or have any feedback to improve the programs, please do one of the following:
1. Create an issue [here on github](https://github.com/poiuyqwert/PyMS/issues)
1. Post in [this thread](http://www.staredit.net/topic/17719/) on [StarEdit.net](http://www.staredit.net)
1. [Email me](mailto:[email protected])
1. Create an issue [on github](https://github.com/poiuyqwert/PyMS/issues)
2. Join the [SEN Discord](https://discord.gg/Bzba93Z5r9) and report iit
3. Post in [this thread](http://www.staredit.net/topic/17719/) on [StarEdit.net](http://www.staredit.net)
4. [Email me](mailto:[email protected])

Please include as much information as possible. If you are reporting an issue, please include:
* The version of the program you had issues with (you can check in Libs\versions.json)
* The version of the program you had issues with (you can check in `PyMS\PyMS\versions.json`)
* The OS you are running on
* The error message or crash logs. If the program crashed without an error dialog, you can check in the Libs\Logs\ folder for the programs log file
* The error message or crash logs. If the program crashed without an error dialog, you can check in the `PyMS\PyMS\Logs\` folder for the programs log file

## Analytics
At the moment PyMS only tracks the launch of PyMS programs, anonamously and with no sensitive information sent. An example of the data sent in these analytics calls:
Expand Down

0 comments on commit 63c0b94

Please sign in to comment.