Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

APP-3060 Documentation revamping, getting started #222

Merged

Conversation

thibauult
Copy link
Member

@thibauult thibauult commented Sep 15, 2020

Revamped README.md, Getting Started guide...

README.md Outdated

# skip building legacy modules
./mvnw clean install -P -legacy
git clone git@github.com:SymphonyPlatformSolutions/symphony-api-client-java.git
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is that necessary (because Github is already giving you that)?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep, removed

README.md Outdated
## How to Build
## Build from Source
The Symphony BDK uses a Maven [build](https://maven.apache.org/) build. The instructions below use the [Maven Wrapper](https://github.com/takari/maven-wrapper)
from the root of the source treen. The wrapper script serves as a cross-platform, self-contained bootstrap mechanism for
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

treen -> tree

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed

README.md Outdated
@@ -9,33 +9,29 @@ The Symphony Java BDK helps you to create Bots and Applications on top of the [S

Documentation about BDK features and usage is available under [docs](./docs/index.md) folder.

## How to Build
## Build from Source
The Symphony BDK uses a Maven [build](https://maven.apache.org/) build. The instructions below use the [Maven Wrapper](https://github.com/takari/maven-wrapper)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

build is written twice

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed 👍

@thibauult thibauult marked this pull request as ready for review September 16, 2020 06:50
@thibauult thibauult requested a review from a team September 16, 2020 06:50
@thibauult thibauult merged commit c37d8fe into finos:master Sep 16, 2020
@thibauult thibauult deleted the APP-3060_Overall-doc-and-getting-started branch September 16, 2020 08:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants