Skip to content
This repository has been archived by the owner on Jun 17, 2024. It is now read-only.

Commit

Permalink
Added build instructions.
Browse files Browse the repository at this point in the history
  • Loading branch information
anshulga committed Sep 27, 2019
1 parent 15884ac commit f0a8d28
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 1 deletion.
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Eclipse metadata
.project

.DS_Store
31 changes: 30 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,31 @@
# pem-utilities
# Partner Engagement Management Utilities
Contributing Partner Engagement Manager utilities and their source code to continue to expand and improve the utilities made available for the PEM solution.

## Getting Started

### Setup build environment
1. Download and install IBM JDK 8 [here](https://developer.ibm.com/javasdk/downloads/sdk8/).
2. Download and install the build tool Gradle version 5.4.1 [here](https://gradle.org/install/).
3. Open a terminal in Linux/Mac or a command prompt in Windows.
4. Navigate to the project directory.
5. Build the project using the following command:
```
gradle clean build
```
6. Navigate to `build/distributions` directory to find the installation package.

### Using the utility
1. Download and install IBM JDK 8 [here](https://developer.ibm.com/javasdk/downloads/sdk8/).
2. Download the latest version of the utility or generate it through the build process.
3. Extract the package to a desired directory.
4. Review the utility's documentation and edit `Config.properties` appropriately.
5. Execute `run.sh` on Linux/Mac or `run.bat` on Windows. You might need to provide 'execute' permissions to the scripts.

## Contributing
We welcome contributions in many forms; there's always plenty to do! Check the [how to contribute](https://github.com/IBM/pem-utilities/CONTRIBUTING.md) page for details.

## Support
Check the documentation [here](https://github.com/IBM/pem-utilities/CONTRIBUTING.md).

## License
The source code files are made available under the Apache License, Version 2.0 (Apache-2.0), located in the [license](https://github.com/IBM/pem-utilities/LICENSE.md) file.

0 comments on commit f0a8d28

Please sign in to comment.