From efcbeac901db9012518a993c109e5990f293c003 Mon Sep 17 00:00:00 2001 From: BoykoAlex Date: Tue, 18 Sep 2018 21:21:43 -0400 Subject: [PATCH] Update README.md files for Atom packages --- atom-extensions/atom-bosh/README.md | 18 +++++++++++------- .../atom-cf-manifest-yaml/README.md | 18 +++++++++++------- atom-extensions/atom-concourse/README.md | 18 +++++++++++------- atom-extensions/atom-spring-boot/README.md | 13 +++++++------ 4 files changed, 40 insertions(+), 27 deletions(-) diff --git a/atom-extensions/atom-bosh/README.md b/atom-extensions/atom-bosh/README.md index 265180478..5385a6b14 100644 --- a/atom-extensions/atom-bosh/README.md +++ b/atom-extensions/atom-bosh/README.md @@ -147,13 +147,17 @@ If you start Atom from a terminal, you can verify that things are setup correctl If that command executes without any errors and returns the cloud-config you expected, then things are setup correctly. If you subsequently launch Atom from that same terminal the dynamic CA and linting should work correctly. -## Dev environment setup: -**Prerequisite**: Node 6.x.x or higher is installed, Atom 1.17 or higher is installed -1. Clone the repository -2. Run `npm install && npm run build` -3. Execute `apm link .` from the folder above -5. Perform `Reload Window` in Atom (Cmd-Shift-P opens commands palette, search for `reload`, select, press `Return`) -6. Open any `pipeline.yml` or `task.yml` file in Atom observe reconciling, content assist and other IDE features +# Releases: + +Released versions of this package can be installed directly from the Atom package installer. + +There are also development snapshots available with the latest fixes and improvements from release git repository: https://github.com/spring-projects/atom-bosh +1. Clone the release repository for Atom package if not already cloned and navigate to `atom-bosh` folder +2. Run `git clean -fxd` - necessary to delete out of date LS JAR file and dependency packages +3. Run `git pull` - get the latest changes +3. Run `npm install` - Install latest dependecnies and download proper LS JAR +4. Run `apm link .` - Link the package to Atom +5. Either start Atom or Reload Window in Atom [linting]: https://raw.githubusercontent.com/spring-projects/sts4/af715bad53bd6cf30a10a2dc6d34bfcc17968382/atom-extensions/atom-bosh/readme-imgs/linting.png diff --git a/atom-extensions/atom-cf-manifest-yaml/README.md b/atom-extensions/atom-cf-manifest-yaml/README.md index 2a825876b..62159401b 100644 --- a/atom-extensions/atom-cf-manifest-yaml/README.md +++ b/atom-extensions/atom-cf-manifest-yaml/README.md @@ -43,13 +43,17 @@ read its detailed documentation. ![Hover Docs Screenshot][hovers] -## Dev environment setup: -**Prerequisite**: Node 6.x.x or higher is installed, Atom 1.17 or higher is installed -1. Clone the repository -2. Run `npm install && npm run build` -3. Execute `apm link .` from the folder above -5. Perform `Reload Window` in Atom (Cmd-Shift-P opens commands palette, search for `reaload`, select, press `Return`) -6. Open any `manifest.yml` file in Atom observe reconciling, content assist and other IDE features +# Releases: + +Released versions of this package can be installed directly from the Atom package installer. + +There are also development snapshots available with the latest fixes and improvements from release git repository: https://github.com/spring-projects/atom-cf-manifest-yaml +1. Clone the release repository for Atom package if not already cloned and navigate to `atom-cf-manifest-yaml` folder +2. Run `git clean -fxd` - necessary to delete out of date LS JAR file and dependency packages +3. Run `git pull` - get the latest changes +3. Run `npm install` - Install latest dependecnies and download proper LS JAR +4. Run `apm link .` - Link the package to Atom +5. Either start Atom or Reload Window in Atom [linting]: https://raw.githubusercontent.com/spring-projects/sts4/af715bad53bd6cf30a10a2dc6d34bfcc17968382/atom-extensions/atom-cf-manifest-yaml/readme-imgs/linting.png [ca]: https://raw.githubusercontent.com/spring-projects/sts4/af715bad53bd6cf30a10a2dc6d34bfcc17968382/atom-extensions/atom-cf-manifest-yaml/readme-imgs/content-assist.png diff --git a/atom-extensions/atom-concourse/README.md b/atom-extensions/atom-concourse/README.md index 7e682a419..8718b0ab0 100644 --- a/atom-extensions/atom-concourse/README.md +++ b/atom-extensions/atom-concourse/README.md @@ -47,13 +47,17 @@ Resource Type declaration? The Atom Outline View (View -> Toggle Outline View) h ![Outline View][outline_view] -## Dev environment setup: -**Prerequisite**: Node 6.x.x or higher is installed, Atom 1.17 or higher is installed -1. Clone the repository -2. Run `npm install && npm run build` -3. Execute `apm link .` from the folder above -5. Perform `Reload Window` in Atom (Cmd-Shift-P opens commands palette, search for `reload`, select, press `Return`) -6. Open any `pipeline.yml` or `task.yml` file in Atom observe reconciling, content assist and other IDE features +# Releases: + +Released versions of this package can be installed directly from the Atom package installer. + +There are also development snapshots available with the latest fixes and improvements from release git repository: https://github.com/spring-projects/atom-concourse +1. Clone the release repository for Atom package if not already cloned and navigate to `atom-concourse` folder +2. Run `git clean -fxd` - necessary to delete out of date LS JAR file and dependency packages +3. Run `git pull` - get the latest changes +3. Run `npm install` - Install latest dependecnies and download proper LS JAR +4. Run `apm link .` - Link the package to Atom +5. Either start Atom or Reload Window in Atom [linting]: https://raw.githubusercontent.com/spring-projects/sts4/af715bad53bd6cf30a10a2dc6d34bfcc17968382/atom-extensions/atom-concourse/readme-imgs/linting.png diff --git a/atom-extensions/atom-spring-boot/README.md b/atom-extensions/atom-spring-boot/README.md index ce605b561..4690306f8 100644 --- a/atom-extensions/atom-spring-boot/README.md +++ b/atom-extensions/atom-spring-boot/README.md @@ -107,12 +107,13 @@ Please report bugs, issues and feature requests on the [Github STS4 issue tracke Released versions of this package can be installed directly from the Atom package installer. -There are also development snapshots available with the latest fixes and improvements as a `.tgz` file -that can be donwloaded from -[here](http://dist.springsource.com/snapshot/STS4/nightly-distributions.html). To install it: -1. Unpack into a folder `` (this folder should have `package.json` file) -2. Execute `apm link .` from that folder -3. Execute `Window Reload` (Package -> Command Palette -> Toggle then search for it) command in the opened Atom instance or open an Atom instance +There are also development snapshots available with the latest fixes and improvements from release git repository: https://github.com/spring-projects/atom-spring-boot +1. Clone the release repository for Atom package if not already cloned and navigate to `atom-spring-boot` folder +2. Run `git clean -fxd` - necessary to delete out of date LS JAR file and dependency packages +3. Run `git pull` - get the latest changes +3. Run `npm install` - Install latest dependecnies and download proper LS JAR +4. Run `apm link .` - Link the package to Atom +5. Either start Atom or Reload Window in Atom [screenshot-live-hovers]: https://raw.githubusercontent.com/spring-projects/sts4/4167094ab94a05657fe4b495770bf93ce3a1585f/atom-extensions/atom-spring-boot/readme-imgs/screenshot-live-hovers.png [screenshot-code-completion]: https://raw.githubusercontent.com/spring-projects/sts4/874c74f3bae0dd08250aeceb46ae5cc2ca720096/atom-extensions/atom-spring-boot/readme-imgs/screenshot-code-completion.png