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

The README seems incomplete #58

Open
upkarlidder opened this issue Sep 10, 2021 · 1 comment
Open

The README seems incomplete #58

upkarlidder opened this issue Sep 10, 2021 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation hacktoberfest stale UI

Comments

@upkarlidder
Copy link
Member

The main README file has instructions on installing the dependencies using the project using npm install command. It does not have further instructions.

The README file in the Web directory has instructions on

  • starting dev server
  • testing the app
  • adding components

We need to connect the two.

Option 1

Move all instructions to the main README

Option 2

Add a link after the installation instructions in the main repo to the readme in the web directory

@wisdomkeeper what do you think? Would you like to take a lead on this?

@demilolu @sforsyth089 @joannhh

@upkarlidder upkarlidder added the UI label Sep 10, 2021
@demilolu demilolu added hacktoberfest documentation Improvements or additions to documentation labels Sep 26, 2021
@github-actions
Copy link

👋 Hi! This issue has been marked stale due to inactivity. If no further activity occurs, it will automatically be closed.

@github-actions github-actions bot added the stale label Oct 27, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation hacktoberfest stale UI
Projects
Status: Backlog
Development

No branches or pull requests

3 participants