diff --git a/README.md b/README.md index 63132084a561d490194a5daa775c9d51a35a2ca3..6aeeee0c86a89ec4d8917acb741f0350b46b8b6f 100644 --- a/README.md +++ b/README.md @@ -15,10 +15,10 @@ line of code :) 2. Install LabProcesses.jl using command `Pkg.clone("https://gitlab.control.lth.se/processes/LabProcesses.jl.git")` Lots of packages will now be installed, this will take some time. ## How to implement a new process -1. Locate the file [interface.jl](https://gitlab.control.lth.se/processes/LabProcesses.jl/blob/master/src/interface.jl) +1. Locate the file [interface.jl](https://gitlab.control.lth.se/processes/LabProcesses.jl/blob/master/src/interface.jl). (Alternatively, you can copy all definitions from [/interface_implementations/ballandbeam.jl](https://gitlab.control.lth.se/processes/LabProcesses.jl/blob/master/src/interface_implementations/ballandbeam.jl) instead. Maybe it's easier to work from an existing implementaiton.) 2. Copy all function definitions. 3. Create a new file under `/interface_implementations` where you paste all the -copied definitions and implement them. See [`/interface_implementations/ballandbeam.jl`](https://gitlab.control.lth.se/processes/LabProcesses.jl/blob/master/src/interface_implementations/ballandbeam.jl) for an example. +copied definitions and implement them. See [/interface_implementations/ballandbeam.jl](https://gitlab.control.lth.se/processes/LabProcesses.jl/blob/master/src/interface_implementations/ballandbeam.jl) for an example. 4. Above all function implementations you must define the process type, e.g, ```julia struct BallAndBeam <: PhysicalProcess