Skip to content

README.md

Latest commit

 

History

History
34 lines (26 loc) · 2.01 KB

README.md

File metadata and controls

34 lines (26 loc) · 2.01 KB
Raw

TAMUSA-ACM.github.io

Project Overview

Welcome to the repository for the official website of the Texas A&M University-San Antonio ACM student chapter. This website serves as a comprehensive resource for all the activities, initiatives, and events organized by the ACM chapter. It also provides a host of resources for students to help them in their academic journey.

Setup and Installation

This project is built using Jekyll, a simple and blog-aware static site generator. To run this project locally, you will need to have Ruby and Jekyll installed on your machine. Follow the instructions below to get the project up and running:

  1. Clone the repository to your local machine using git clone https://github.com/TAMUSA-ACM/TAMUSA-ACM.github.io.git
  2. Navigate to the cloned repository using cd TAMUSA-ACM.github.io
  3. Install Jekyll and other dependencies using bundle install
  4. Run the Jekyll server using bundle exec jekyll serve
  5. Open your browser and navigate to http://localhost:4000

Usage Examples

Once you have the project running on your local machine, you can use it to:

  • Get updates on upcoming events organized by the ACM chapter.
  • Access various resources provided for students.
  • Learn more about the activities and initiatives of the ACM chapter.

Contribution Guidelines

We welcome contributions from anyone who wants to improve the website. Before making contributions, please follow these guidelines:

  1. Fork this repository to your GitHub account.
  2. Clone the forked repository to your local machine.
  3. Create a new branch for your changes.
  4. Make your changes and commit them with a clear and concise commit message.
  5. Push your changes to your forked repository.
  6. Create a pull request describing the changes you made.

Before creating a pull request, please make sure your changes do not break the project and are consistent with the overall design and structure of the website.

License

This project is licensed under the MIT License. For more details, please see the LICENSE file.