Skip to content

Commit ccb1c4f

Browse files
Update README with symlink instructions
1 parent 58acea7 commit ccb1c4f

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

MiniScript-cpp/README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,15 @@ This folder contains the source code of the C++ implementation of the [MiniScrip
66

77
MiniScript is built with [CMake](https://cmake.org/). You can generate your desired flavour of build files as usual from either the CMake GUI or using `cmake` on the command line. If you are unfamiliar with CMake and want to build right now, use the GUI, or follow the command-line steps below.
88

9-
1. Create a directory in this (MiniScript-cpp) folder called `build`. (Don't worry, it will be ignored by git.)
9+
1. Clone [minimicro-sysdisk](https://github.com/JoeStrout/minimicro-sysdisk) in the same directory as this repository (so minimicro-sysdisk and miniscript should be folders next to each other, with this directory (MiniScript-cpp) in miniscript). We use a lot of the same libraries as Mini Micro, so having both of them next to each other lets us avoid having 2 copies of the same library.
1010

11-
2. `cd build` to change to that build directory.
11+
2. Create a directory in this (MiniScript-cpp) folder called `build`. (Don't worry, it will be ignored by git.)
1212

13-
3. `cmake ../..` (or on Windows, `cmake ..\..`) to generate a makefile and related files in the build directory.
13+
3. `cd build` to change to that build directory.
1414

15-
4. `cmake --build . --config Release` to actually do the build.
15+
4. `cmake ../..` (or on Windows, `cmake ..\..`) to generate a makefile and related files in the build directory.
16+
17+
5. `cmake --build . --config Release` to actually do the build.
1618

1719
If successful, you should find an executable called `miniscript` (or `miniscript.exe` on Windows) which you can install (see **Installation**, below). You'll also find a shared library (libminiscript-cpp.a, miniscript-cpp.lib, or similar) for you to link to in your own projects if you like. You can even `include()` the CMakeLists.txt of this project inside your own for clean dependency management.
1820

0 commit comments

Comments
 (0)