linde12 / kod

terminal text editor written in Go, using xi-editor as backend
MIT License
315 stars 20 forks source link

Add build instructions #1

Closed jmi2k closed 7 years ago

jmi2k commented 7 years ago

It would help people who doesn't have any previous experience with Go (like me!) but want to get started quickly and try this project.

linde12 commented 7 years ago

Yes, sorry, been very busy this week.

I'll update the readme with some instructions!

linde12 commented 7 years ago

I've updated the readme, to build kod you should really only need to run go build once go is installed and in your path. But right now you have to build xi-core (and xi-syntect-plugin if you'd like) yourself as well.

It's not a top priority now to make it bundled together, at least not until we've got a stable version of xi-core with the features.

tl;dr Build the core with cargo build and kod with go build, place the executables in the same directory and run kod from there. E.g:

/home/linde12/go/src/github.com/linde12/kod $ go build
/home/linde12/go/src/github.com/linde12/kod $ ./kod ~/js/../index.js
jmi2k commented 7 years ago

I see, the problem was that I was trying that the sources weren't located in my $GOPATH accordingly! I'd like to be able to build it from wherever I clone the repo, but I don't know anything about Go packaging guidelines so I'll just leave it as a comment.