README.md

ULX Documentation

The official documentation for the ULX admin mod for Garry’s Mod!

Contributing

You can help improve the documentation!

• Open an issue to report an error or make a suggestion.
• Create a pull request to propose changes to the documentation.

Building

These build instructions will help you set up a local version of the site.

Requirements

This project uses Bundler to install and run Jekyll. Bundler manages Ruby gem dependencies, reduces Jekyll build errors, and prevents environment-related bugs. To install Bundler, you must install Ruby.

• Ruby (2.1.0 or higher)
• Bundler

Installation

1. git clone https://github.com/Timmy/ulx-docs.git - Download the repository to your computer.
2. cd ulx-docs - Change the working directory to the project root.
3. bundle install - Install Jekyll and other dependencies.

Run local site

1. bundle exec jekyll serve -b "" - Build the site and serve it locally.
2. Open http://localhost:4000 in your browser.