purduesigbots / pros-atom3

Provides integration with the PROS 3.x ecosystem
https://pros.cs.purdue.edu
Mozilla Public License 2.0
7 stars 0 forks source link

Setup Instructions for PROS plugin on existing Atom Install #40

Open KZeronimo opened 5 years ago

KZeronimo commented 5 years ago

This should be moved under pros-atom3

Expected Behavior:

Currently using Atom and install pros plugin - expect the same experience as the PROS Editor

Actual Behavior:

There are a number of differences

  1. Console behavior
  2. Have to build and install cquery out of band
  3. Maybe more

Steps to reproduce:

Install pros plugin on existing up to date install of Atom Install PROS Editor Note difference in behavior

System information:

Operating System (e.g. Windows, OS X, Ubuntu): Windows 10

Atom Version: Latest

Plugin Version (PROS version): Latest

Additional Information

Screenshots

edjubuh commented 5 years ago

This sounds like a long term mission for us. I don't think we'll be interested in trying to package cquery with the pros-atom3 plugin. The console has been a great example of things going wrong when you expect native binaries to be included in the plugin. That being said, we do distribute pre-built cquery on Azure

HotelCalifornia commented 5 years ago

we've definitely had a lot of issues with the console, but what differences in behavior do you mean?

KZeronimo commented 5 years ago

Thanks for the quick reply guys - let me rephrase my question

If I have Atom already installed and configured to taste and I want to use PROS - what is the process beyond installing the pros-atom3 package to get the same experience offered by the PROS Editor?

So far I know I need to

I know I can run Atom and PROS Editor side by side and that might end up being the best answer - I don't know how much you've done in your fork of Atom to achieve the experience offered by the PROS Editor ...

HotelCalifornia commented 5 years ago

The instructions for Linux should get you what you need

KZeronimo commented 5 years ago

@HotelCalifornia - I've tried a variation of that by installing the pros-atom3 package - should I be installing the bootstrapper instead?

Just curious if you have tried that recipe and end up with Atom being at parity with PROS Editor

HotelCalifornia commented 5 years ago

Um yeah you should end up at parity with the editor by installing the bootstrapper, as that's basically what the editor does

KZeronimo commented 5 years ago

@HotelCalifornia - thank you - I'll try again fresh this time with the bootstrapper instead of the pros-atom3 package and let you know how it goes.

A point of clarification between the purpose of the bootstrapper and the pros-atom3 package would be helpful especially since the package catalog states - ... "You probably don't want to manually install this package." about the bootstrapper package.

edjubuh commented 5 years ago

You don't want to manually install pros-boostrapper. What went wrong with installation as outlined here?

The end effect of pros-boostrapper and pros-atom3 is going to be nearly identical. The bootstrapper has a package dependency on pros-atom3, pros-atom3's package dependencies, and some minimap packages that we thought most users would appreciate being installed by default. If you just install pros-atom3, you should get all the necessary dependencies required for PROS to work inside Atom.

KZeronimo commented 5 years ago

@edjubuh - thanks for the reply - if I recall - when I perform a build action in the PROS Editor I get output to the terminal and I have a console being filtered for PROS output - the terminal interaction and console are missing in the Atom + PROS Package

Let me do this clean again and report back - I take it from out thread it should be as easy as the steps I outlined here to achieve Atom + PROS = PROS Editor

edjubuh commented 5 years ago

Let me do this clean again and report back - I take it from out thread it should be as easy as the steps I outlined here to achieve Atom + PROS = PROS Editor

I'll give a more thorough listing:

  1. Install PROS CLI + Toolchain through either installers or manually with pip and from Arm's website
  2. Install Atom
  3. Install cquery, either by building yourself or finding online
  4. Install pros-atom3 in your Atom installation
HotelCalifornia commented 5 years ago

You don't want to manually install pros-boostrapper.

To clarify, installing the bootstrapper from inside atom will install the old version of the atom package. You will need to use apm to install the correct version, as outlined in the instructions I linked above.