Merge remote-tracking branch 'origin/master'

Sunmark25 · Nov 29, 2023 · 39f68ea · 39f68ea
2 parents eb8f4d3 + 470291e
commit 39f68ea
Showing 1 changed file with 33 additions and 53 deletions.
diff --git a/README.md b/README.md
@@ -1,7 +1,5 @@
 # AirClip
-
 ## About AirClip
-
 AirClip is a versatile web/mobile application designed for efficient clipboard history management
 and synchronization across various devices and operating systems. Developed using modern C++, SQL and the Wt library,
 it offers a user-friendly interface and robust features for both individual and collaborative work environments.
@@ -19,8 +17,8 @@ For any inquiries, feedback, or contributions, please feel free to contact the p
    - [Getting Started with AirClip](#getting-started-with-airclip)
    - [Managing Clipboard History](#managing-clipboard-history)
 - [Troubleshooting](#troubleshooting)
-   - [Common Issues and Solutions](#common-issues-and-solution)
-   - [Frequently Asked Questions (FAQs)](#frequently-asked-questions-(faqs))
+   - [Common Issues and Solutions](#common-issues-and-solutions)
+   - [Frequently Asked Questions (FAQs)](#frequently-asked-questions-faqs)
 - [Authors](#authors)
 
 ## Key Features
@@ -31,46 +29,32 @@ For any inquiries, feedback, or contributions, please feel free to contact the p
 - **Secure Data Handling:** Emphasis on security and privacy in storing and transmitting clipboard data.
 
 ## Getting Started
-
 To **build and run** AirClip, you will need the following libraries and tools:
-
 ### Required Libraries and Third-Party Tools
-
 1. **Wt**: A C++ library for developing web applications.
    - Version: (Refer to Wt's official documentation for compatible versions)
    - [Official Website](https://www.webtoolkit.eu/wt)
    - Installation: Follow the installation guidelines provided by the official Wt documentation.
-
 2. **SQLite3**: A C library that provides a lightweight disk-based database.
    - [Official Website](https://www.sqlite.org/)
    - Installation:
-
-     - Depending on your OS, you can typically use a package manager. For example, on Ubuntu/Debian you can use the command:
-       ```
-       sudo apt-get install libsqlite3-dev
-       ```
-       
+     Depending on your OS, you can typically use a package manager. For example, on Ubuntu you can use the command:
+     ```
+     sudo apt-get install libsqlite3-dev
+     ```
 3. **libasio-dev** (Required for Crowcpp):
    - This library is essential for the server functionalities related to Crowcpp.
-   - Installation:
-
-     - Depending on your OS, you can typically use a package manager. For example, on Ubuntu/Debian you can use the command:
-       ```
-       sudo apt-get install libasio-dev
-       ```
-       
-     - On macOS you can use:
-       ```
-       brew install asio
-       ```
-       
+   - Installation: Install it using the package manager with the following command:
+     ```
+      sudo apt-get install libasio-dev
+     ```
 4. **Qt**: A framework for cross-platform application and UI development
    - Used for developing sophisticated GUI applications.
    - [Official Website](https://www.qt.io/)
    - Installation: Follow the installation guidelines provided on the Qt website. Ensure compatibility with the version used in AirClip.
 
-### Building from Source Code
 
+### Building from Source Code
 #### Prerequisites
 - A modern C++ compiler (e.g., GCC, Clang)
 - CMake (Version 3.26 or higher recommended)
@@ -80,46 +64,43 @@ To **build and run** AirClip, you will need the following libraries and tools:
 
 ## Running the Application
 1. **Clone the Repository:** Begin by cloning the AirClip repository to your local machine.
-    ```
-    git clone https://github.com/Sunmark25/AirClip.git
-    ```
-   
+```
+git clone https://repo.csd.uwo.ca/scm/compsci3307_f2023/group36.git
+```
 2. **Navigate to the Directory:** Change to the directory containing the source code.
-    ```
-    cd AirClip
-    ```
-   
+```
+cd AirClip
+```
 3. **Create a Build Directory:** It's a good practice to keep build files separate from the source. Do this by creating a directory where the build files will be generated.
-    ```
-    mkdir build
-    ```
-    ```
-    cd build
-    ```
-   
-4. **Run CMake:** Use CMake to generate the build system.
+```
+mkdir build
+```  
+```
+cd build
+```
+4. **Run CMake:**
+   Use CMake to generate the build system.
 
    a. If Wt is installed in the standard directory, simply run:
+
     ```
     cmake ..
     ```
 
    b. Otherwise, if Wt is not installed in the standard directory, then you'll need to run the command below. And you'll to replace `[path_to_wt_config]` with the path to your `WtConfig.cmake` or `wt-config` file if it's not in the default system:
+
     ```
     cmake .. -DCMAKE_PREFIX_PATH=[path_to_wt_config]
     ``` 
-   
 5. **Build the project:** Compile the project using the build system generated by CMake.
-    ```
-    make
-    ```
+```
+make
+```
 6. **Run the Application:**: After a successful build, you can run AirClip from the build directory:
-    ```
-    ./AirClip
-    ```
-   
+```
+./AirClip
+```
 ## Usage Guide
-
 #### Getting Started with AirClip
 - **Accessing the Web Interface:** Open your web browser and navigate to the AirClip application URL.
 - **Logging In:** Use your credentials to log in, or register if you're a new user.
@@ -133,7 +114,6 @@ To **build and run** AirClip, you will need the following libraries and tools:
    - Sync in Action: Copy items on one device and find them available on all other connected devices.
 
 ## Troubleshooting
-
 ### Common Issues and Solutions
 - App Not Syncing: Check your internet connection and ensure all devices are logged into the same account.
 - Installation Errors: Verify system requirements and ensure all dependencies are installed.