diff --git a/doc/setup/installing_linux.adoc b/doc/setup/installing_linux.adoc deleted file mode 100644 index dafb8c50a..000000000 --- a/doc/setup/installing_linux.adoc +++ /dev/null @@ -1,11 +0,0 @@ -= Installing OSI on Linux - -Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. -Et malesuada fames ac turpis egestas. -Mauris pharetra et ultrices neque ornare aenean euismod elementum nisi. -Nulla facilisi morbi tempus iaculis urna id. Justo eget magna fermentum iaculis. -Sed augue lacus viverra vitae congue eu. -Velit ut tortor pretium viverra suspendisse. -Amet commodo nulla facilisi nullam vehicula ipsum a. -Nibh nisl condimentum id venenatis a. -Diam vel quam elementum pulvinar etiam non quam lacus suspendisse. \ No newline at end of file diff --git a/doc/setup/installing_linux_cpp.adoc b/doc/setup/installing_linux_cpp.adoc new file mode 100644 index 000000000..590d1667d --- /dev/null +++ b/doc/setup/installing_linux_cpp.adoc @@ -0,0 +1,61 @@ += Installing OSI for C++ on Linux + +**Prerequisites** + +* You have _cmake_ installed. +* You have installed _protobuf_. +* You must have super user privileges. + +**Steps** + +. Open a terminal. +. Clone the Open Simulation repository. ++ +[source] +---- +git clone https://github.com/OpenSimulationInterface/open-simulation-interface.git +---- ++ +. Change into the repository directory. ++ +[source] +---- +cd open-simulation-interface +---- ++ +. Create a new directory for the build. ++ +[source] +---- +mkdir build +---- ++ +. Change into the new directory. ++ +[source] +---- +cd build +---- ++ +. Run cmake. + To build a 32-bit target under 64-bit linux, add `-DCMAKE_CXX_FLAGS="-m32"` to the cmake command. + In this case, protobuf must be in 32-bit mode too. ++ +[source] +---- +cmake .. +---- ++ +. Run make. ++ +[source] +---- +make +---- ++ +. Install Open Simulation Interface. ++ +[source] +---- +sudo make install +---- diff --git a/doc/setup/installing_linux_python.adoc b/doc/setup/installing_linux_python.adoc new file mode 100644 index 000000000..8b753aba8 --- /dev/null +++ b/doc/setup/installing_linux_python.adoc @@ -0,0 +1,43 @@ += Installing OSI for Python on Linux + +**Prerequisites** + +* You have installed _pip3_. +* You have installed _python-setuptools_. +* You have installed _protobuf_. +* For local installation, you have installed _virtualenv_. + +**Steps** + +. Open a terminal. +. Clone the Open Simulation repository. ++ +[source] +---- +git clone https://github.com/OpenSimulationInterface/open-simulation-interface.git +---- ++ +. Change into the repository directory. ++ +[source] +---- +cd open-simulation-interface +---- ++ +. Create a new virtual environment. ++ +[source] +---- +virtualenv -p python3 venv +---- ++ +. Activate the virtual environment. ++ +[source] +---- +source venv/bin/activate +---- ++ +. Install Open Simulation Interface. +Local installation:: `pip3 install .` +Global installation:: `sudo pip3 install .` diff --git a/doc/setup/installing_windows.adoc b/doc/setup/installing_windows.adoc deleted file mode 100644 index 156c4984c..000000000 --- a/doc/setup/installing_windows.adoc +++ /dev/null @@ -1,10 +0,0 @@ -= Installing OSI on Windows - -Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. -Et malesuada fames ac turpis egestas. -Mauris pharetra et ultrices neque ornare aenean euismod elementum nisi. -Nulla facilisi morbi tempus iaculis urna id. Justo eget magna fermentum iaculis. -Sed augue lacus viverra vitae congue eu. Velit ut tortor pretium viverra suspendisse. -Amet commodo nulla facilisi nullam vehicula ipsum a. -Nibh nisl condimentum id venenatis a. -Diam vel quam elementum pulvinar etiam non quam lacus suspendisse. \ No newline at end of file diff --git a/doc/setup/installing_windows_cpp.adoc b/doc/setup/installing_windows_cpp.adoc new file mode 100644 index 000000000..145c2be11 --- /dev/null +++ b/doc/setup/installing_windows_cpp.adoc @@ -0,0 +1,54 @@ += Installing OSI on Windows + +**Prerequisites** + +* You have installed _cmake_ as administrator. +* You have installed _protobuf_ as administrator. + +**Steps** + +. Open a terminal as administrator. +. Clone the Open Simulation repository. ++ +[source] +---- +git clone https://github.com/OpenSimulationInterface/open-simulation-interface.git +---- ++ +. Change into the repository directory. ++ +[source] +---- +cd open-simulation-interface +---- ++ +. Create a new directory for the build. ++ +[source] +---- +mkdir build +---- ++ +. Change into the new directory. ++ +[source] +---- +cd build +---- ++ +. Run cmake. + To build a 64-bit target, add `Win64` to the generator name. + In this case, protobuf and protoc.exe must be in 64-bit mode too. ++ +[source] +---- +cmake .. [-G ] [-DCMAKE_INSTALL_PREFIX=] +---- ++ +. Build and install OSI. ++ +[source] +---- +cmake --build . [--config Release] +cmake --build . --target install +---- diff --git a/doc/setup/installing_windows_python.adoc b/doc/setup/installing_windows_python.adoc new file mode 100644 index 000000000..f1b0640e3 --- /dev/null +++ b/doc/setup/installing_windows_python.adoc @@ -0,0 +1,30 @@ += Installing OSI for Python on Windows + +**Prerequisites** + +* You have installed _Python_ with administrator rights. +* Make sure _Python_ is added to `PATH`. + +**Steps** + +. Open a terminal. +. Clone the Open Simulation repository. ++ +[source] +---- +git clone https://github.com/OpenSimulationInterface/open-simulation-interface.git +---- ++ +. Change into the repository directory. ++ +[source] +---- +cd open-simulation-interface +---- ++ +. Run the setup script. ++ +[source] +---- +python setup.py install +----