Skip to content

Commit 25c5f70

Browse files
committed
Update readme
1 parent 8393b85 commit 25c5f70

1 file changed

Lines changed: 12 additions & 11 deletions

File tree

README.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -157,37 +157,38 @@ To build the library use the following commands.
157157

158158
```
159159
git clone https://github.com/techsenger/ceffx
160-
cd ceffx // project root directory
160+
# Enter the project root directory
161+
cd ceffx
161162
```
162163

163164
2. Build native code
164165

165166
```
166-
# Create and enter the `build` directory. The `build` directory name is required by other tooling and should not be changed.
167+
# Create and enter the `build` directory (it is required by other tooling and should not be changed)
167168
cd native && mkdir build && cd build
168169
169-
# Linux: Generate 64-bit Unix Makefiles.
170+
# Linux: Generate 64-bit Unix Makefiles
170171
cmake -G "Unix Makefiles" -DCMAKE_BUILD_TYPE=Release ..
171-
# Build using Make.
172+
# Build using Make
172173
make -j4
173174
174-
# MacOS: Generate 64-bit Xcode project files.
175+
# MacOS: Generate 64-bit Xcode project files
175176
cmake -G "Xcode" -DPROJECT_ARCH="x86_64" ..
176177
# Open ceffx.xcodeproj in Xcode
177178
# - Select Scheme > Edit Scheme and change the "Build Configuration" to "Release"
178-
# - Select Product > Build.
179+
# - Select Product > Build
179180
180-
# MacOS: Generate ARM64 Xcode project files.
181+
# MacOS: Generate ARM64 Xcode project files
181182
cmake -G "Xcode" -DPROJECT_ARCH="arm64" ..
182183
# Open ceffx.xcodeproj in Xcode
183184
# - Select Scheme > Edit Scheme and change the "Build Configuration" to "Release"
184-
# - Select Product > Build.
185+
# - Select Product > Build
185186
186-
# Windows: Generate 64-bit VS2022 project files.
187+
# Windows: Generate 64-bit VS2022 project files
187188
cmake -G "Visual Studio 17" -A x64 ..
188189
# Open ceffx.sln in Visual Studio
189190
# - Select Build > Configuration Manager and change the "Active solution configuration" to "Release"
190-
# - Select Build > Build Solution.
191+
# - Select Build > Build Solution
191192
```
192193
3. Build Java code
193194

@@ -205,7 +206,7 @@ To run the demo execute the following commands in the root of the project:
205206
cd java && cd ceffx-demo
206207
mvn javafx:run
207208

208-
Please note, that debugger settings are in `tabpanepro-demo/pom.xml` file.
209+
Please note, that debugger settings are in `ceffx-demo/pom.xml` file.
209210

210211
## License <a name="license"></a>
211212

0 commit comments

Comments
 (0)