Spring/spring-tools
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update README.md files for Atom packages

Browse Source
This commit is contained in:
BoykoAlex
2018-09-18 21:21:43 -04:00
parent 676b87079a
commit efcbeac901
4 changed files with 40 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
atom-extensions/atom-bosh/README.md
View File

@@ -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

18
atom-extensions/atom-cf-manifest-yaml/README.md
View File

@@ -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

18
atom-extensions/atom-concourse/README.md
View File

@@ -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

13
atom-extensions/atom-spring-boot/README.md
View File

@@ -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 `<package>` (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