Add some instructions

Project: http://git-wip-us.apache.org/repos/asf/cayenne-website/repo
Commit: http://git-wip-us.apache.org/repos/asf/cayenne-website/commit/f9174cd8
Tree: http://git-wip-us.apache.org/repos/asf/cayenne-website/tree/f9174cd8
Diff: http://git-wip-us.apache.org/repos/asf/cayenne-website/diff/f9174cd8

Branch: refs/heads/master
Commit: f9174cd83250cbdc6ba6e99bc3a6cfbee29c2e53
Parents: d2f1e6f
Author: Aristedes Maniatis <[email protected]>
Authored: Mon May 29 20:01:07 2017 +1000
Committer: Aristedes Maniatis <[email protected]>
Committed: Mon May 29 20:01:07 2017 +1000

----------------------------------------------------------------------
 README.txt | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/cayenne-website/blob/f9174cd8/README.txt
----------------------------------------------------------------------
diff --git a/README.txt b/README.txt
new file mode 100644
index 0000000..f00fbf8
--- /dev/null
+++ b/README.txt
@@ -0,0 +1,16 @@
+A website for the Apache Cayenne project.
+
+To build this site on OSX:
+
+1. Install homebrew
+2. # brew install rbenv-bundler
+3. cd to the top of this folder
+4. # rbenv install
+5. # bundler install
+6. # jekyll s
+
+From time to time you might need to repeat steps 4 and 5 if the version of 
ruby or gems are upgraded.
+
+When you run the jekyll server in step 6, you'll be able to browse to 
localhost and view the site. As you change files, the site rebuilds 
automatically in a few seconds.
+
+The output of the site can be found in _site if that needs to be copied to 
another location for deployment.
\ No newline at end of file

Reply via email to