Aurora-Sim/Development

De DigiWiki.

Developing Aurora-Sim

NOTES: This really should be split into many pages each large section probably becoming a page

      Needs cleaned up, and a bit more 'beef' added to it

Documentation and Code Contribution Home

Documentation references can be found at our documentation home.

Getting the Source Code

The Aurora-Sim source code is hosted at https://github.com/ and can be accessed at
https://github.com/aurora-sim/aurora-sim/
and this uses git as the source versioning system.

The source code can be pulled directly from

git clone https://github.com/aurora-sim/Aurora-Sim.git

Git help

How to create a new instance of the git repository. This will create a new folder named Aurora-Sim and download/pull all the files in the repository from the server.

How to update an existing repository

First change into the repository directory, and run

git clean -xf -d && git pull

This will remove any changed files before merging newer changes into the local repository.

Git Branches

Sometimes git repositories have multiple branches/versions. It is possible to list current branches with..

git branch

It is possible to change the branch with

git checkout <branch>

In cases where you want to experiment with code it is best to create your own branch, this can be done like so.

git branch <branch name>
git checkout <branch name>
Git Remotes

A remote is like a link to another repository, it can allow you to merge or cheery-pick commits/patches from other projects.

Please ensure you read the terms and conditions of all projects/repositories involved with development.

To add a remote the syntax is: git remote add <name> <uri>, and then a "git fetch" is required update tracking. git remote update, updates the local repository.

git remote add opensim https://github.com/opensim/opensim.git
git fetch
git remote update

List remote branches

git branch -r

Checkout remote branch

git checkout -b <remote name> <branch name>
Git Cherrypicking

It may be nessicary to update the repositories before cherry-picking.

git remote update

Cherry-picking commits from remote branches

git cherry-pick <commit ID>

Checking conflicts

git diff

Commiting all changed files

git commit -a
Outils personnels
  • Cette page a été consultée 1 354 fois.
donate
Google Ads