Skip to content

Commit bc2a4f1

Browse files
authored
Merge pull request #4 from mossmaurice/IOX-#3-fix-typos-in-docu
[IOX#3] Fix typos, repair links and comment-out Debian package usage
2 parents e5c23ea + c685620 commit bc2a4f1

File tree

2 files changed

+14
-9
lines changed

2 files changed

+14
-9
lines changed

README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,7 @@ so he can stream his favorite [video](https://www.youtube.com/watch?v=g5NkgZXWl0
5353

5454
## Download
5555

56+
<!--
5657
Either download our pre-built daemon (called RouDi) and our runtime lib or build everything yourself.
5758
5859
### Release
@@ -61,6 +62,7 @@ Either download our pre-built daemon (called RouDi) and our runtime lib or build
6162
dpkg -i iceoryx.deb
6263
6364
You've sucessfully installed iceoryx! Continue with the section examples to see how to get started developing applications using iceoryx.
65+
-->
6466

6567
### Development
6668

@@ -81,29 +83,29 @@ iceoryx_utils and iceoryx_posh are deployed as independent cmake packages. Posh
8183
For the first start we advise to use our build-test script for building everything.
8284

8385
git clone https://github.com/eclipse/iceoryx.git
84-
./tools/iceoryx_build-test.sh
86+
./tools/iceoryx_build_test.sh
8587

8688
In default-mode the script is not building the provided test. For a clean build just add "clean" as first argument to the script.
8789

8890
#### Build with tests
8991

9092
To build iceoryx with tests, just add "test" as first argument to the script.
9193

92-
./tools/iceoryx_build-test.sh test
94+
./tools/iceoryx_build_test.sh test
9395

9496
The Googletest-Framework will be automatically fetched from github and the test will be executed and the end of the script.
9597

9698
Congrats! You've build all the necessary things to continue playing around with the examples.
9799

98100
## Examples
99101

100-
Great that your still here, time for code! The following examples give you a quick and easy introduction into the inner
102+
Great that you're still here, time for code! The following examples give you a quick and easy introduction into the inner
101103
workings of iceoryx. We hope you enjoy our sightseeing tour!
102104

103105
|Name | Description | Technologies |
104106
|---|---|---|
105-
| [icedelivery](./examples/icedelivery) | Transfer data between POSIX applications | [SoA](https://en.wikipedia.org/wiki/Service-oriented_architecture), service description |
106-
| [ros-on-ice](http://link.to.ros.implementation) | See how iceoryx can be used inside the robot operating system (will come) | ROS, RMW |
107+
| [icedelivery](./iceoryx_examples/icedelivery) | Transfer data between POSIX applications | [SoA](https://en.wikipedia.org/wiki/Service-oriented_architecture), service description |
108+
| [rmw_iceoryx](https://github.com/ros2/rmw_iceoryx) | See how iceoryx can be used inside the robot operating system | ROS, RMW |
107109

108110
Is something missing or you've got ideas for other nifty examples? Jump right away to the next section!
109111

iceoryx_examples/README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Building the examples
22

3-
A warm welcome to iceoryx examples Readme! You can build all the example either by using the Debian package or
3+
A warm welcome to iceoryx examples Readme!
4+
<!-- You can build all the example either by using the Debian package or
45
build things from scratch.
56
67
## Debian package
@@ -11,13 +12,15 @@ the examples, do the following:
1112
./iceexample# mkdir build && cd build
1213
./iceexample/build# cmake ..
1314
./iceexample/build# cmake --build .
15+
-->
1416

1517
## Build everything from source
1618

1719
When building all the bits from source, build RouDi and the runtime as described in the main
18-
[Readme.md](../README.md#user-content-development) with `./tools/iceoryx_build-test.sh`. Just add the path of the
19-
`build` directory:
20+
[Readme.md](../README.md#user-content-development) with `./tools/iceoryx_build_test.sh`. All examples are automatically
21+
built when using the script. If you want to build one example standalone add the path of the `build` directory when
22+
calling `cmake` after you have run the script:
2023

2124
./iceexample# mkdir build && cd build
22-
./iceexample/build# cmake .. -DCMAKE_INSTALL_PREFIX="`pwd`/../../../build/"
25+
./iceexample/build# cmake .. -DCMAKE_INSTALL_PREFIX="`pwd`/../../../build/install/prefix"
2326
./iceexample/build# cmake --build .

0 commit comments

Comments
 (0)