Skip to content

00 Readme

Jump to bottom
xovertheyearsx edited this page Apr 10, 2018 · 4 revisions

Contents

Readme

  1. READ ALL OF THIS README

  2. README.md

  3. USER GUIDE

Overview

A lot of users typically experience similar issues. Sometimes as users we fail to report specific details that could help developers and other users as well. It's not fully the users fault since they are unaware of those details.

Typically, a user will prefer to just use the software and not neccessarily need to know how the software may operate. This is known as black-boxing.

In certain situations, especially as a developer using development tools, this frequently fails to be the case. Generally (in my experience), the less you know about the tools that you utilize, the more frustration you will experience.

As a developer there is only so much we can do to resolve or mitigate a particular issue. I hope to resolve those problems by addressing them here.

Issues

  1. A issue may not be replied to if Logs, Error Messages, and Version details are missing. Reproduction steps are a big help in reproducing a specific case by case scenario.

  2. A issue may remain unresolved and be eventually closed or merged with another resembling issue if you reply with little, or no detail, on how you handled your issue.

  3. Re-open closed issues if the issue seems to be related to yours; even if it's old. Provide information based on your circumstances. Other people may be experiencing a similar issue. Saying, "Me too", and, "Same here", doesn't help any one. Provide details!

  4. New an issue if you have any questions and or suggestions.

Releases

Sometimes a new update breaks the experience which can be frustrating. You can always revert to an older version to remedy your current situation. You are not obligated in any way to use the lastest package.

Note: If you do this, you will no longer recieve updates. You will be stuck with the version you manually installed. If you choose to update, you'll have to manually remove the package, and then use Atom to install the latest package release.

  1. Remove the currently installed version of atom-python-run

  2. You can find release versions here as a compressed archive file.

  3. Select the archive version that you'd like to download by clicking on zip or tar.gz

  4. Decompress the archived repository. This will extract the atom-python-run package.

  5. Move the directory to somewhere out of sight and out of mind. Make note of the directory that you place the package in. Documents is usually a good place.

  6. Open the command line (even if you don't know how to use it).

Windows

win + r -> cmd -> ok

link the package to Atom and type in the console window

C:\> apm link %userprofile%\Documents\atom-python-run

to unlink the package

C:\> apm unlink %userprofile%\Documents\atom-python-run

Mac OS X/Linux

(Mac Users) cmd + space -> terminal -> enter

(Linux Users) Open your preferred terminal

link the package to Atom and type in the console window

$ apm link ~/Documents/atom-python-run

to unlink the package

$ apm unlink ~/Documents/atom-python-run

Contributions

We are a community of volunteers and do not get paid for our work or efforts. Please do not treat us as if this is the case. Be polite and courteous at all times and we will reply and handle your issue if we can.

Please new an issue or make a pull request if you can figure out a fix on your own. Add details and documentation if you can, or need to, to relfect any changes you may have made.

Clone this wiki locally