celix-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From rlenfer...@apache.org
Subject celix-site git commit: Updated README with instructions for initializing the celix submodule
Date Tue, 21 Nov 2017 10:46:53 GMT
Repository: celix-site
Updated Branches:
  refs/heads/asf-site 017c8d6e5 -> 7e241a0a7


Updated README with instructions for initializing the celix submodule


Project: http://git-wip-us.apache.org/repos/asf/celix-site/repo
Commit: http://git-wip-us.apache.org/repos/asf/celix-site/commit/7e241a0a
Tree: http://git-wip-us.apache.org/repos/asf/celix-site/tree/7e241a0a
Diff: http://git-wip-us.apache.org/repos/asf/celix-site/diff/7e241a0a

Branch: refs/heads/asf-site
Commit: 7e241a0a7c9861bf13b0d681253d938aa88b752b
Parents: 017c8d6
Author: Roy Lenferink <rlenferink@apache.org>
Authored: Tue Nov 21 11:46:51 2017 +0100
Committer: Roy Lenferink <rlenferink@apache.org>
Committed: Tue Nov 21 11:46:51 2017 +0100

----------------------------------------------------------------------
 README.md | 15 +++++++++++++--
 1 file changed, 13 insertions(+), 2 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/celix-site/blob/7e241a0a/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index 6d8a1e6..8bad555 100644
--- a/README.md
+++ b/README.md
@@ -10,15 +10,26 @@ This repository contains:
 
 1. `src/`: the source of the site, including markdown files containing the bulk of the content
 1. `site/`: html generated from the markdown (which is what is actually hosted on the website)
-1. `celix/`: dummy celix sourcecode
+1. `celix/`: the celix sourcecode
+
+### Cloning this repo
+This repository can be cloned as usual. Because the website is using the offical celix repository
as submodule, some extra commands need to be executed. Run this after cloning and the 'celix'
directory will be initialized:
+```bash
+$ git submodule init
+$ git submodule update
+```
+
+More about submodules can be found [here](https://git-scm.com/book/en/v2/Git-Tools-Submodules)
 
 # Server build instructions
+
 ### building
 ```bash
 cd path/to/build.py
 ./build.py
 ```
 A test-server will run on [localhost:8000](https://localhost:8000/)
+
 ### installing 
-1. install [python](https://www.python.org/)(tested versions: 2.7.10)
+1. install [python](https://www.python.org/) (tested versions: 2.7.10)
 1. install [markdown2](https://github.com/trentm/python-markdown2/blob/master/README.md#install)


Mime
View raw message