Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Slfdspln authored May 4, 2023
1 parent 5a20468 commit ff94c2f
Showing 1 changed file with 30 additions and 2 deletions.
32 changes: 30 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@ logo generation
<img width="817" alt="Screenshot 2023-05-03 at 4 45 04 PM" src="https://user-images.githubusercontent.com/121422214/236075333-7bd33531-e086-4c32-8765-279e1e21cee8.png">
Examples of Generated Logos
<img width="323" alt="Screenshot 2023-05-03 at 5 31 20 PM" src="https://user-images.githubusercontent.com/121422214/236079419-ba090c98-022d-4f75-b76e-677a9c3126f2.png">
<img width="362" alt="Screenshot 2023-05-03 at 5 33 44 PM" src="https://user-images.githubusercontent.com/121422214/236079587-1c8c93db-abee-43b7-b860-fe5b61e12ea1.png">
<img width="327" alt="Screenshot 2023-05-03 at 5 36 09 PM" src="https://user-images.githubusercontent.com/121422214/236079906-4106014d-85ed-4008-8f1a-abd9ff592793.png">
<img width="323" alt="Screenshot 2023-05-03 at 5 33 44 PM" src="https://user-images.githubusercontent.com/121422214/236079587-1c8c93db-abee-43b7-b860-fe5b61e12ea1.png">
<img width="323" alt="Screenshot 2023-05-03 at 5 36 09 PM" src="https://user-images.githubusercontent.com/121422214/236079906-4106014d-85ed-4008-8f1a-abd9ff592793.png">

## Technologies Used

Expand All @@ -32,3 +32,31 @@ This project utilizes Node.js v16, inquirer v8.2.4 (node package manager), and f
## Installation

1. Clone the repo: git clone [email protected]:Slfdspln/logo-maker.git
2. To access, utilize VS Code. Installation is necessary if not currently installed.
3. To install node.js v16 using the terminal, refer to the documentation for the appropriate command. For instance, if you have homebrew, you can use the command 'brew install node@16'.
4. After installing node.js v16, use the command "npm init -y" in the terminal to create a package.json file for storing project files.
5.
Using the terminal, run "npm i" to install the application's dependencies. For inquirer and jest, developers can install them directly from the command line using "npm i [email protected]" for version 8.2.4 of inquirer and "npm i jest" for the latest version of jest.
6. Type "node index.js" in the terminal to run the application.

## Usage Information

To run the application, navigate to its directory using the command line, install dependencies (npm i), and run the command "node index.js". Answer the questions that follow and once done, a message will appear confirming the logo generation. Check the newly generated SVG file for your new logo.

For unit testing, refer to the Test Instructions section.

## Test Instructions

To perform unit testing, execute the command "npm run test" in the terminal. Currently, there is a single test suite containing three tests. This suite verifies that the render() method generates the correct string for the specified shape color in the associated SVG file.

<img width="797" alt="Screenshot 2023-05-03 at 5 59 53 PM" src="https://user-images.githubusercontent.com/121422214/236083446-1826fb1d-4699-4e3b-8a0f-be6412ee4d30.png">

## License

NOTICE: This application is covered under the MIT License

## Questions

Need more information? You can contact me through my GitHub or email. Links provided below.


0 comments on commit ff94c2f

Please sign in to comment.