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 #3

Closed
3 tasks
Popovkov57 opened this issue Oct 8, 2022 · 6 comments
Closed
3 tasks

Update README #3

Popovkov57 opened this issue Oct 8, 2022 · 6 comments

Comments

@Popovkov57
Copy link
Owner

Popovkov57 commented Oct 8, 2022

Hi,

I need to:

  • Improve style of the README
  • Add instruction to install and run the program
  • Add Licence

Thanks. Best regards

@Prakhar9450
Copy link

Please assign me this issue

@PratyayDhond
Copy link

I can do this, give me a bit more information about this in short

@PavvanPradeep
Copy link

can you assign this issue to me

@adarsh-kishore786
Copy link
Contributor

For running this application, nodejs must be installed in the system, which can be downloaded from the official nodejs website.

We also need to have the npm package unique-random-array which can be installed via

npm install unique-random-array

For testing on src/index.test.js we need to have the jest unit-testing package

npm install --save-dev jest

and make a change in package.json

"scripts": {
  "test": "jest"
}

Then, by running npm test we can do unit testing.

For including this application in any other program, we can require it and use its random function. For example

console.log(random(2));

This is what I have understood and if you assign this to me, then I can write it in README as instructions to install and run program.

@Popovkov57
Copy link
Owner Author

Popovkov57 commented Oct 8, 2022

Hi @adarsh-kishore786 , @PratyayDhond , @PavvanPradeep and @Prakhar9450

No need to assign the issue. It's open source.

To contribute, see this.

Best regards.

@Popovkov57
Copy link
Owner Author

Issue closes. Thanks @adarsh-kishore786

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

5 participants