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

Update README.md #308

Merged
merged 2 commits into from
Apr 1, 2021
Merged

Update README.md #308

merged 2 commits into from
Apr 1, 2021

Conversation

Anushka-shukla
Copy link
Contributor

@Anushka-shukla Anushka-shukla commented Apr 1, 2021

Issue: #307
Adding installation steps in ReadMe to get the application running in the local system

Description

In the ReadMe.MD it's nowhere mentioned that first, you have to clone, and then inside the project directory we have to run: "docker-compose up". This can be a little confusing for the first-timers.

Motivation and Context

I was trying to get the application running on my system. I downloaded docker and docker-compose as it was upfront mentioned, then it was mentioned to run: docker-compose up. This started giving me the below error:

Can't find a suitable configuration file in this directory or any
parent. Are you in the right directory?
Supported filenames: docker-compose.yml, docker-compose.yaml, compose.yml, compose.yaml"

Screenshots (if appropriate):

Screenshot from 2021-04-01 10-21-27

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • [x ] My change requires a change to the documentation.
  • [ x] I have updated the documentation accordingly.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

Copy link
Member

@mr-c mr-c left a comment

Choose a reason for hiding this comment

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

Dear @Anushka-shukla

Thank you for helping us improve the documentation! I've made a few suggestions.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@mr-c mr-c merged commit ba5c577 into common-workflow-language:main Apr 1, 2021
obasekiosa pushed a commit to obasekiosa/cwlviewer that referenced this pull request Apr 9, 2021
This pull request was closed.
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