Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Updated readme to match current checkout and dev process

  • Loading branch information...
commit ddccc8bf055f1f8a78bcd177c2163f5d6112da87 1 parent 8a0f0a4
@rsms authored
Showing with 13 additions and 13 deletions.
  1. +11 −13 README.md
  2. +2 −0  pull.sh
View
24 README.md
@@ -13,35 +13,33 @@ If you want to use Kod, simply download the latest "stable" version from [http:/
## Development
-### 1. Get the source
-
-It's recommended you clone the repository `git://github.com/rsms/kod.git`:
+**Get the source:**
git clone --recursive https://github.com/rsms/kod.git
-### 2. Build node
+**Build dependencies:**
deps/node-build.sh
-
-### 3. Build libcss
-
deps/libcss/build.sh
-### 4. Configure Source Highlight
+**Setup Source Highlight:**
-This currently requires MacPorts. Sorry.
+Note: This currently requires [MacPorts](http://www.macports.org/).
@jehiah
jehiah added a note

you should be able to 'brew install source-highlight' with homebrew which is much more osx friendly http://mxcl.github.com/homebrew/

@rsms Owner
rsms added a note

I will.

@blixt
blixt added a note

Yeah brew worked fine for me.

@rsms Owner
rsms added a note

And it resulted in an isolated (i.e. no references to your brew prefix), universal (i386+x86_64) product?

Use otool -L <path> on a binary/library to list dependencies.

@blixt
blixt added a note
$ otool -L /usr/local/bin/source-highlight
/usr/local/bin/source-highlight:
    /usr/local/Cellar/source-highlight/3.1.4/lib/libsource-highlight.3.dylib (compatibility version 4.0.0, current version 4.1.0)
    /usr/local/lib/libboost_regex-mt.dylib (compatibility version 0.0.0, current version 0.0.0)
    /usr/lib/libstdc++.6.dylib (compatibility version 7.0.0, current version 7.9.0)
    /usr/lib/libSystem.B.dylib (compatibility version 1.0.0, current version 125.2.1)
@rsms Owner
rsms added a note

Yeah, that build will obviously only work on your computer.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
port install source-highlight +universal
deps/srchilight/import-from-macports.sh
deps/srchilight/import-lang-files.sh
-### 5. Check out chromium-tabs
+**Start hacking:**
- git clone git://github.com/rsms/chromium-tabs.git
+ open kod.xcodeproj
-### 6. Start hacking
- open kod.xcodeproj
+### Refreshing your clone
+
+Since Kod is made up of a main repositroy as well as a few sub-repositories (git submodules) a simple `git pull` is not sufficient to update your source tree clone. Use the `pull.sh` shell script for this:
+
+ ./pull.sh
## License
View
2  pull.sh
@@ -0,0 +1,2 @@
+#!/bin/sh
+git pull && git submodule update --init
Please sign in to comment.
Something went wrong with that request. Please try again.