Skip to content

Commit 8ed5287

Browse files
authored
Update README.md
1 parent 179c57e commit 8ed5287

File tree

1 file changed

+21
-39
lines changed

1 file changed

+21
-39
lines changed

README.md

Lines changed: 21 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -59,30 +59,6 @@ Visit the live version at: [https://nellowtcs.github.io/HTMLRunner/](https://nel
5959

6060
### Single File
6161
Due to the Webpack build being rather large, I recommend using the website, but you do you :D. </br>
62-
However, formatting your code isn't working in the Web Version currently.
63-
64-
### Local Installation
65-
66-
1. **Clone the repository**
67-
```bash
68-
git clone https://github.com/NellowTCS/HTMLRunner.git
69-
cd HTMLRunner/Build
70-
```
71-
72-
2. **Install dependencies**
73-
```bash
74-
npm install
75-
```
76-
77-
3. **Build the project**
78-
```bash
79-
npm run build
80-
```
81-
82-
3. **Or Build and auto serve locally**
83-
```bash
84-
npm start
85-
```
8662

8763
## Usage
8864

@@ -96,7 +72,7 @@ However, formatting your code isn't working in the Web Version currently.
9672

9773
### Keyboard Shortcuts
9874
- `Ctrl/Cmd + Enter` - Run code
99-
- `Ctrl/Cmd + F` - Format current editor
75+
- `Ctrl/Cmd + F` and `Ctrl/Cmd + H` - Find or Replace code
10076
- `Ctrl/Cmd + /` - Toggle comment
10177
- `Tab` / `Shift + Tab` - Indent / Unindent
10278

@@ -163,24 +139,30 @@ function testFunction() {
163139
## 🔧 Development
164140

165141
### Prerequisites
166-
- Node.js (v14 or higher)
142+
- Node.js (v18 or higher)
167143
- npm or yarn
168144

169-
### Development Setup
170-
```bash
171-
git clone https://github.com/NellowTCS/HTMLRunner.git
172-
173-
cd HTMLRunner/Build
174-
175-
# Install dependencies
176-
npm install
145+
### Local Installation and/or Development Setup
146+
(this is if you want to install locally but not use the single file version, or if you want to contribute.)
177147

178-
# Build for production
179-
npm run build
148+
1. **Clone the repository**
149+
```bash
150+
git clone https://github.com/NellowTCS/HTMLRunner.git
151+
cd HTMLRunner/Build
152+
```
180153

181-
# Test
182-
npm test [ Your Tests ]
183-
```
154+
2. **Build**
155+
```
156+
./build.sh
157+
```
158+
or (if you also want to build the single file version)
159+
```
160+
./build-all.sh
161+
```
162+
3. **Or Build and auto serve locally**
163+
```bash
164+
npm start
165+
```
184166

185167
### Contributing
186168
1. Fork the repository

0 commit comments

Comments
 (0)