From 0d18c48a8ca0c03101faccfca5c9f1d2a138194f Mon Sep 17 00:00:00 2001 From: Mabel Zhang Date: Thu, 24 Dec 2020 00:46:34 -0500 Subject: [PATCH 1/2] add windows installation Signed-off-by: Mabel Zhang --- README.md | 50 ++++++++++++++++++++++++++++++++++++++++++++------ 1 file changed, 44 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 245665150..e99c8c5b5 100644 --- a/README.md +++ b/README.md @@ -20,13 +20,17 @@ Test coverage: ## Installation ## +### UNIX + Standard installation can be performed in UNIX systems using the following steps: - - mkdir build/ - - cd build/ - - cmake .. - - sudo make install +``` +mkdir build/ +cd build/ +cmake .. +sudo make install +``` sdformat supported cmake parameters at configuring time: - USE_INTERNAL_URDF (bool) [default False] @@ -36,8 +40,42 @@ sdformat supported cmake parameters at configuring time: Use the sdformat team compilation flags instead of the common set defined by cmake. +### Windows + +Install prerequisites: + +``` +conda install urdfdom --channel conda-forge +``` + +Install Ignition dependencies: + +``` +conda install libignition-tools1 --channel conda-forge +``` + +Configure and build: + +``` +mkdir build +cd build +cmake .. -DBUILD_TESTING=OFF # Optionally, -DCMAKE_INSTALL_PREFIX=path\to\install +cmake --build . --config Release +``` + +Install: + +``` +cmake --install . --config Release +``` + ## Uninstallation ## +### UNIX + To uninstall the software installed with the previous steps: - - cd build/ - - sudo make uninstall + +``` +cd build/ +sudo make uninstall +``` From c55255d0313c28e7a1d7502822289a5cac26b218 Mon Sep 17 00:00:00 2001 From: Mabel Zhang Date: Thu, 24 Dec 2020 12:02:25 -0500 Subject: [PATCH 2/2] small tweak Signed-off-by: Mabel Zhang --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index e99c8c5b5..76e114a34 100644 --- a/README.md +++ b/README.md @@ -42,6 +42,13 @@ sdformat supported cmake parameters at configuring time: ### Windows +Create if necessary, and activate a Conda environment: + +``` +conda create -n ign-ws +conda activate ign-ws +``` + Install prerequisites: ```