|
1 | | -# LED Arena documentation |
| 1 | +# LED Arena Documentation |
2 | 2 |
|
3 | | -This repository is to generate the website about [Modular LED Displays](https://reiserlab.github.io/Modular-LED-Display). |
| 3 | +This repository generates the website for [Modular LED Displays](https://reiserlab.github.io/Modular-LED-Display). |
4 | 4 |
|
5 | 5 | ## Development Setup |
6 | 6 |
|
7 | 7 | ### Prerequisites |
8 | 8 |
|
9 | | -Before you begin, make sure you have the following installed: |
| 9 | +Before you begin, ensure you have the following tools installed: |
10 | 10 |
|
11 | | -1. **pixi** - A package manager for managing development environments |
12 | | - - Follow the installation instructions at [pixi installation guide](https://pixi.sh/latest/#installation) |
| 11 | +1. **pixi** - Package manager for development environments |
| 12 | + - Follow the [pixi installation guide](https://pixi.sh/latest/#installation) |
13 | 13 |
|
14 | 14 | 2. **rbenv** - Ruby version manager |
15 | | - - Check if rbenv is installed by running `rbenv --version` |
16 | | - - If not installed, follow the instructions for your platform at [rbenv installation guide](https://github.com/rbenv/rbenv#installation) |
| 15 | + - Verify installation by running `rbenv --version` |
| 16 | + - If not installed, follow the platform-specific instructions at the [rbenv installation guide](https://github.com/rbenv/rbenv#installation) |
17 | 17 |
|
18 | 18 | ### Cloning the Repository |
19 | 19 |
|
20 | | -This repository uses git submodules. To clone the entire website with all submodules, use: |
| 20 | +This repository uses Git submodules. Clone the complete website with all submodules using: |
21 | 21 |
|
22 | 22 | ```bash |
23 | 23 | git clone --recurse-submodules https://github.com/reiserlab/Modular-LED-Display.git |
24 | 24 | ``` |
25 | 25 |
|
26 | | -If you've already cloned the repository without submodules, you can initialize them with: |
| 26 | +If you have already cloned the repository without submodules, initialize them using: |
27 | 27 |
|
28 | 28 | ```bash |
29 | 29 | git submodule update --init --recursive |
30 | 30 | ``` |
31 | 31 |
|
32 | 32 | ### Running a Local Server |
33 | 33 |
|
34 | | -Once you have the prerequisites installed and the repository cloned, you can start a local development server: |
| 34 | +Once the prerequisites are installed and the repository is cloned, start a local development server: |
35 | 35 |
|
36 | 36 | ```bash |
37 | 37 | pixi run localhost |
38 | 38 | ``` |
39 | 39 |
|
40 | | -This will start a local server where you can preview the website and your changes. |
| 40 | +This starts a local server where you can preview the website and test your changes. |
0 commit comments