Skip to content

Commit

Permalink
Update: Update Project Documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
hoangsonww authored Oct 16, 2024
1 parent 1d9b04c commit 0ab9230
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,18 @@ This Java application is designed to manage and manipulate the artwork database

## Features
- Add new artwork entries to the museum's database.
- Sort the artworks based on specified attributes in ascending or descending order.
- Sort the artworks based on specified attributes in ascending or descending order using Merge Sort, a highly efficient sorting algorithm.
- Generate random lists of artwork for display or analysis.
- Find artworks by a specific artist.
- Implement a specialized random sort that organizes artworks into categories based on multiple attributes.

## Prerequisites
- Java Development Kit (JDK) 11 or higher.
- A Java IDE (e.g. IntelliJ or Eclipse) is highly recommended.

## Setup and Installation
1. Ensure Java is installed on your system. You can download JDK from the [Oracle website](https://www.oracle.com/java/technologies/javase-jdk11-downloads.html).
2. Clone this repository to your local machine using `git clone <repository-url>`.
2. Clone this repository to your local machine using `git clone https://github.com/hoangsonww/Sorting-Algorithms-DSA.git`.
3. Compile the Java files from your terminal or command prompt:
```bash
javac ArtMuseum.java Art.java
Expand All @@ -29,6 +30,8 @@ This Java application is designed to manage and manipulate the artwork database
java Tester
```

Or, you can simplify these steps with a Java-supported IDE such as IntelliJ IDEA!

## Usage
### Adding Artworks
To add artworks to the database, you'll need to instantiate `Art` objects and add them to an `ArtMuseum` instance using the `add` method.
Expand All @@ -47,4 +50,4 @@ Contributions to the project are welcome. Please fork the repository, make your
---
Created with ❤️ by [Son Nguyen](https://github.com/hoangsonww) in 2023.
Created with ❤️ by [Son Nguyen](https://github.com/hoangsonww) in 2023.

0 comments on commit 0ab9230

Please sign in to comment.