Skip to content

Commit

Permalink
Updated Readme of many apps
Browse files Browse the repository at this point in the history
  • Loading branch information
Waldek Kozaczuk committed Jun 18, 2018
1 parent fb75be4 commit ab94fb1
Show file tree
Hide file tree
Showing 11 changed files with 22 additions and 12 deletions.
2 changes: 1 addition & 1 deletion apps/cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@ capstan package compose cli-example
```
Run this run the app:
```
capstan run cli-example --boot default
capstan run cli-example -p qemu --boot default
```
5 changes: 3 additions & 2 deletions apps/elasticsearch/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
This is an example of simple java 'Hello World' app running on OSv.
This is an example of Elasticsearch 6.3 running on OSv.

Here are the steps to build the image:

Init the package
```
capstan package init --name "elasticsearch" --title "Elasticsearch OSS 6.3" --author "Anonymous" --version "6.3" --require "openjdk8-zulu-compact3-with-java-beans" --require "osv.run-java"
capstan package init --name "elasticsearch" --title "Elasticsearch OSS 6.3" --author "Anonymous" \
--version "6.3" --require "openjdk8-zulu-compact3-with-java-beans" --require "osv.run-java"
```
Fetch elasticsearch binaries.
```
Expand Down
2 changes: 1 addition & 1 deletion apps/golang-example/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Here are the steps to build the image:

Init the package
```
capstan package init --name "go-example" --title "Golang Example" --author "Anonymous" \\
capstan package init --name "go-example" --title "Golang Example" --author "Anonymous" \
--version "1.0" --require "osv.run-go"
```
Compile golang source code
Expand Down
3 changes: 2 additions & 1 deletion apps/iperf/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
Init the package
```
capstan package init --name "iperf-example" --title "Iperf Example" --author "Anonymous" --version "1.0" --require "osv.iperf"
capstan package init --name "iperf-example" --title "Iperf Example" \
--author "Anonymous" --version "1.0" --require "osv.iperf"
```
Run this to compose:
```
Expand Down
4 changes: 3 additions & 1 deletion apps/java-example/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@ Here are the steps to build the image:

Init the package
```
capstan package init --name "java-example" --title "Java Example" --author "Anonymous" --version "1.0" --require "osv.openjdk10-java-base" --require "osv.run-java"
capstan package init --name "java-example" --title "Java Example" \
--author "Anonymous" --version "1.0" --require "osv.openjdk10-java-base" \
--require "osv.run-java"
```
Compile java source code
```
Expand Down
3 changes: 2 additions & 1 deletion apps/lighttpd/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
Init the package
```
capstan package init --name "lighttpd-example" --title "Lighttpd Example" --author "Anonymous" --version "1.0" --require "osv.lighttpd"
capstan package init --name "lighttpd-example" --title "Lighttpd Example" \
--author "Anonymous" --version "1.0" --require "osv.lighttpd"
```
Run this to compose:
```
Expand Down
3 changes: 2 additions & 1 deletion apps/memcached/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
Init the package
```
capstan package init --name "memcached-example" --title "Memcached Example" --author "Anonymous" --version "1.0" --require "osv.memcached"
capstan package init --name "memcached-example" --title "Memcached Example" \
--author "Anonymous" --version "1.0" --require "osv.memcached"
```
Run this to compose:
```
Expand Down
3 changes: 2 additions & 1 deletion apps/mysql/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
Init the package
```
capstan package init --name "mysql-example" --title "MySQL Example" --author "Anonymous" --version "1.0" --require "osv.mysql"
capstan package init --name "mysql-example" --title "MySQL Example" \
--author "Anonymous" --version "1.0" --require "osv.mysql"
```
Run this to compose:
```
Expand Down
3 changes: 2 additions & 1 deletion apps/netperf/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
Init the package
```
capstan package init --name "netperf-example" --title "Netperf Example" --author "Anonymous" --version "1.0" --require "osv.netperf"
capstan package init --name "netperf-example" --title "Netperf Example" \
--author "Anonymous" --version "1.0" --require "osv.netperf"
```
Run this to compose:
```
Expand Down
3 changes: 2 additions & 1 deletion apps/node-example/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ Here are the steps to build the image:

Init the package
```
capstan package init --name "node-example" --title "Node.JS Example" --author "Anonymous" --version "1.0" --require "osv.node-js"
capstan package init --name "node-example" --title "Node.JS Example" \
--author "Anonymous" --version "1.0" --require "osv.node-js"
```
Add run init to specify how to execute the app (please look at meta/run.yaml)
Compose the package
Expand Down
3 changes: 2 additions & 1 deletion apps/python-example/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ Here are the steps to build the image:

Init the package
```
capstan package init --name "python-example" --title "Python 2.7 Example" --author "Anonymous" --version "1.0" --require "python-2.7"
capstan package init --name "python-example" --title "Python 2.7 Example" \
--author "Anonymous" --version "1.0" --require "python-2.7"
```
Add run init to specify how to execute the app (please look at meta/run.yaml)
Compose the package
Expand Down

0 comments on commit ab94fb1

Please sign in to comment.