R3 Host-Kit Source Access via Git

	Contents
Summary Why Git? Repository Source Download Via HTTP Via Git Via Subversion Uploading Source Changes Line Terminators Push Method Git Resources

Updated: 11-Apr-2024/21:32:38 UTC (F5 to reload)

Summary

R3/Host-Kit sources are available via github.com.

This is how we will be controlling/maintaining sources in the future. It's still experimental, but we hope that this method makes for more rapid community distribution and development of the Host-Kit.

Why Git?

Git is a distributed revision control system that has become popular in recent years. Basic usage is simple.

In a nutshell:

1. You clone a copy of the entire repository. You can stop here if you want.
2. Optionally, you can pull or fetch updates when they are made.
3. Optionally, you can contribute changes, you push them back.

Repository

The main repository will be stored on GitHub.com, which provides a decent website with various useful features. You do not need an account to download sources. In fact, you don't even need git to download, you can use HTTP.

Source Download

Under construction: the URLs are for testing, not final.

Via HTTP

Anyone can download the Host-Kit source as a gzip/zip archive. You do not need a github account.

• Page: github.com/carls/R3A110 (temp)
• As tgz: github.com/carls/R3A110/tarball/master (temp)
• As zip: github.com/carls/R3A110/zipball/master (temp)

For quick reference to developers, the URL will also be posted to REBOL 3 Change Log: 2010.

Via Git

If you want to use git to download the source, you will need a git client. This method gives you a lot more control over how you sync-up change to the repository.

Git clients come in a few varieties: Git Downloads

For windows, we recommend: msysgit. The shell client is about 12MB. (See note below regarding line terminators.)

The command to obtain the entire repository is:

git clone git://github.com/carls/R3A110.git  (temp for testing)

You do not need a github.com user account.

Via Subversion

Subversion access is also provided to the Github repositories:

svn co https://svn.github.com/carls/R3A110 (temp)

Uploading Source Changes

Line terminators: our official repository uses LF ("Unix") line endings. But, you can set your client to use other endings. See note below.

To contribute changes to the Host-Kit source:

1. Obtain a github.com account
2. Fork (clone) the Host-Kit repository to your account (this is your own copy)
3. From your git client, push (upload) your changes to your repository
4. Inform us of your changes

We will review your submissions and go from there.

Line Terminators

The Host-Kit source files use LF (line feed) terminators. That's also the official line terminator used by REBOL strings.

However, if you want, you can set the core.autocrlf option true in the config for Git, and it will convert the sources to your local format for your editing convenience. Then, it will restore them to LF if you push changes back.

Push Method

Here's an example of how a push is done from the local repository to the github one.

Note: You will need to provide a public ssh key to github first.

git remote add origin git@github.com:carls/R3A110.git
git push origin master

Git Resources

Git Site Official website for Git Git Tutorial A very simple and quick tutorial. Gittutorial Very basic, written as a man page. GitRef One of the best currently available tutorials. Git Tutorial by Lars Vogel More detailed, nicely organized. Git Cheat Sheet Large size

Understanding Git Conceptually More detailed introduction. Git User Manual From the official location. Pro Git A good online published book on Git. Git Community Book An online book about Git. Git for Computer Scientists The basic architecture and how DAGs are used for dependencies.

(If you know of other good ones, tell me -Carl)