diff --git a/.gitignore b/.gitignore deleted file mode 100644 index 9d842ed..0000000 --- a/.gitignore +++ /dev/null @@ -1,2 +0,0 @@ -build/ -conf.py diff --git a/How to Contribute/Git Setup.rst b/How to Contribute/Git Setup.rst new file mode 100644 index 0000000..173ebdb --- /dev/null +++ b/How to Contribute/Git Setup.rst @@ -0,0 +1,51 @@ +Installing and Setting Up Git +============ + +At the heart of GitHub is an open source version control system (VCS) called Git*. Created by the same team that created Linux, Git is responsible for everything GitHub related that happens locally on your computer. + +`Download and install the latest version of Git. +`_. + +Use the default options for each step. + +Setup Git +---------- + +Now that you have Git installed, it's time to configure your settings. To do this you need to open Git Bash (not the Windows command line). + +Git Configuration +---------- + +**Username** + +First you need to tell git your name, so that it can properly label the commits you make. + +.. code-block:: bash + + git config --global user.name "Your Hame Here" + # Sets the default name for git to use when you commit + +**Email** + +Git saves your email address into the commits you make. We use the email address to associate your commits with your GitHub account. + +.. code-block:: bash + + git config --global user.email "your_email@example.com" + # Sets the default email for git to use when you commit + +Your email address for Git should be the same one associated with your GitHub account. If it is not, see this guide for help adding additional emails to your GitHub account. If you want to keep your email address hidden, this guide may be useful to you. + + +Password caching +---------- + +The last option we need to set will tell git that you don't want to type your username and password every time you talk to a remote server. + +Tip: You need git 1.7.10 or newer to use the credential helper To use this option, you need install a credential helper. + +GitHub for Windows includes this helper, and provides a git shell so you don't need to install and configure git manually. + +If you don't want to use GitHub for Windows, you can download the helper for your OS here: + +Windows Vista, 7, & 8 (.NET 4.0 required) Source Unzip the file and run the git-credential-winstore.exe program inside. This will start up the helper and update your git config to use it. \ No newline at end of file diff --git a/How to Contribute/Using Git.rst b/How to Contribute/Using Git.rst new file mode 100644 index 0000000..b5d4218 --- /dev/null +++ b/How to Contribute/Using Git.rst @@ -0,0 +1,70 @@ +Using Git to Contribute +============ + +If you have not already, you need to install and set up Git before you can perform these steps. If you need help with doing that see the Git Setup guide in the contributing folder. + +The process you are about to preform is to fork a repository. Which makes a copy of it for your Github account. While SWGANH is open source, we do not allow direct commits. This is so developers can review the accuracy of the code. Accuracy can be a multitude of things, including: It's functionality, It's ability to perform, If it has bugs, or even if it is content is before publish 14.1. + +Forking a Repository +---------- + +To start, you need to fork the repository you want to work with. In this instance we will say it is "swganh", the main server core. Forking adds a copy of the repository to your account. It is the first step in contributing. + +.. image:: https://github-images.s3.amazonaws.com/help/Bootcamp-Fork.png + +Cloning your Repository +---------- + +The next step is to clone your repository with Git. This is downloading it to your computer. To do so, run the following code. + +.. code-block:: bash + + cd C:/Users/your-user-account/where-ever-you-want-your-repository + # Goes to that specified location. That is where your files will get downloaded too. + git clone https://github.com/**your-username**/swganh.git + # Clones your fork of the repository into the current directory in terminal + + +Committing +---------- + +After you have changed a file in the source or added some content and you wish to submit it to be reviewed by the Developers, you can make a commit. + +.. code-block:: bash + + git status + # lists the status of the master. Telling you what files are different from the current public + # repository on github (if you used "cd C:/your-origin-whatever") + +Find the files you want to change and type + +.. code-block:: bash + + git add path-to-file.file-type + # Adds the specified files. + +If you alter multiple files and want to commit all of them, you can use: + +.. code-block:: bash + + git add * + +If you delete a file and want it to be completley removed/deleted from the repository when you commit, you can use: + +.. code-block:: bash + + git rm * (or git rm path-to-file.file-type + +Then when you are ready to commit: + +.. code-block:: bash + git commit "Added Rebel Themepark" + # Where the "" represents the commit message. + + +Submitting a Pull Request +---------- + +When you have a commit, or more than one commit ready to be sent for review you need to submit a "Pull Request" so developers can preview your changes, then approve or decline it. Do that on this page: + +https://github.com/anhstudios/swganh/compare \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..8b94227 --- /dev/null +++ b/README.md @@ -0,0 +1,7 @@ +SWG:ANH Documentation +=========== + +Welcome to the SWG:ANH Documentation Repository. This repository provides guides, information, and tutorials on using SWG:ANH tools and services. + + +Browse the various folders to find what you are looking for. If you need help, please do not hesitate to ask on our forums. diff --git a/CMakeLists.txt b/old/CMakeLists.txt similarity index 100% rename from CMakeLists.txt rename to old/CMakeLists.txt diff --git a/book/architecture.rst b/old/book/architecture.rst similarity index 100% rename from book/architecture.rst rename to old/book/architecture.rst diff --git a/book/events.rst b/old/book/events.rst similarity index 100% rename from book/events.rst rename to old/book/events.rst diff --git a/book/index.rst b/old/book/index.rst similarity index 100% rename from book/index.rst rename to old/book/index.rst diff --git a/book/installation.rst b/old/book/installation.rst similarity index 100% rename from book/installation.rst rename to old/book/installation.rst diff --git a/book/installation_client.rst b/old/book/installation_client.rst similarity index 100% rename from book/installation_client.rst rename to old/book/installation_client.rst diff --git a/book/installation_docs.rst b/old/book/installation_docs.rst similarity index 100% rename from book/installation_docs.rst rename to old/book/installation_docs.rst diff --git a/book/installation_linux.rst b/old/book/installation_linux.rst similarity index 100% rename from book/installation_linux.rst rename to old/book/installation_linux.rst diff --git a/book/installation_windows.rst b/old/book/installation_windows.rst similarity index 100% rename from book/installation_windows.rst rename to old/book/installation_windows.rst diff --git a/book/map.rst.inc b/old/book/map.rst.inc similarity index 100% rename from book/map.rst.inc rename to old/book/map.rst.inc diff --git a/book/plugins.rst b/old/book/plugins.rst similarity index 100% rename from book/plugins.rst rename to old/book/plugins.rst diff --git a/book/scripting.rst b/old/book/scripting.rst similarity index 100% rename from book/scripting.rst rename to old/book/scripting.rst diff --git a/book/services.rst b/old/book/services.rst similarity index 100% rename from book/services.rst rename to old/book/services.rst diff --git a/conf.py.in b/old/conf.py.in similarity index 100% rename from conf.py.in rename to old/conf.py.in diff --git a/contributing/index.rst b/old/contributing/index.rst similarity index 100% rename from contributing/index.rst rename to old/contributing/index.rst diff --git a/contributing/issues.rst b/old/contributing/issues.rst similarity index 100% rename from contributing/issues.rst rename to old/contributing/issues.rst diff --git a/contributing/license.rst b/old/contributing/license.rst similarity index 100% rename from contributing/license.rst rename to old/contributing/license.rst diff --git a/contributing/map.rst.inc b/old/contributing/map.rst.inc similarity index 100% rename from contributing/map.rst.inc rename to old/contributing/map.rst.inc diff --git a/contributing/pull_requests.rst b/old/contributing/pull_requests.rst similarity index 100% rename from contributing/pull_requests.rst rename to old/contributing/pull_requests.rst diff --git a/contributing/security.rst b/old/contributing/security.rst similarity index 100% rename from contributing/security.rst rename to old/contributing/security.rst diff --git a/contributing/standards.rst b/old/contributing/standards.rst similarity index 100% rename from contributing/standards.rst rename to old/contributing/standards.rst diff --git a/contributing/tests.rst b/old/contributing/tests.rst similarity index 100% rename from contributing/tests.rst rename to old/contributing/tests.rst diff --git a/cookbook/index.rst b/old/cookbook/index.rst similarity index 100% rename from cookbook/index.rst rename to old/cookbook/index.rst diff --git a/cookbook/map.rst.inc b/old/cookbook/map.rst.inc similarity index 100% rename from cookbook/map.rst.inc rename to old/cookbook/map.rst.inc diff --git a/cookbook/plugins/best_practices.rst b/old/cookbook/plugins/best_practices.rst similarity index 100% rename from cookbook/plugins/best_practices.rst rename to old/cookbook/plugins/best_practices.rst diff --git a/cookbook/scripting/command_scripts.rst b/old/cookbook/scripting/command_scripts.rst similarity index 100% rename from cookbook/scripting/command_scripts.rst rename to old/cookbook/scripting/command_scripts.rst diff --git a/cookbook/security/custom_authentication.rst b/old/cookbook/security/custom_authentication.rst similarity index 100% rename from cookbook/security/custom_authentication.rst rename to old/cookbook/security/custom_authentication.rst diff --git a/images/contributing/pull_requests_image_1.png b/old/images/contributing/pull_requests_image_1.png similarity index 100% rename from images/contributing/pull_requests_image_1.png rename to old/images/contributing/pull_requests_image_1.png diff --git a/index.rst b/old/index.rst similarity index 100% rename from index.rst rename to old/index.rst diff --git a/pythonapi/command.rst b/old/pythonapi/command.rst similarity index 100% rename from pythonapi/command.rst rename to old/pythonapi/command.rst diff --git a/pythonapi/creature.rst b/old/pythonapi/creature.rst similarity index 100% rename from pythonapi/creature.rst rename to old/pythonapi/creature.rst diff --git a/pythonapi/index.rst b/old/pythonapi/index.rst similarity index 100% rename from pythonapi/index.rst rename to old/pythonapi/index.rst diff --git a/pythonapi/kernel.rst b/old/pythonapi/kernel.rst similarity index 100% rename from pythonapi/kernel.rst rename to old/pythonapi/kernel.rst diff --git a/pythonapi/map.rst.inc b/old/pythonapi/map.rst.inc similarity index 100% rename from pythonapi/map.rst.inc rename to old/pythonapi/map.rst.inc diff --git a/pythonapi/object.rst b/old/pythonapi/object.rst similarity index 100% rename from pythonapi/object.rst rename to old/pythonapi/object.rst diff --git a/pythonapi/object_controller.rst b/old/pythonapi/object_controller.rst similarity index 100% rename from pythonapi/object_controller.rst rename to old/pythonapi/object_controller.rst diff --git a/pythonapi/objects.rst b/old/pythonapi/objects.rst similarity index 100% rename from pythonapi/objects.rst rename to old/pythonapi/objects.rst diff --git a/pythonapi/player.rst b/old/pythonapi/player.rst similarity index 100% rename from pythonapi/player.rst rename to old/pythonapi/player.rst diff --git a/pythonapi/services.rst b/old/pythonapi/services.rst similarity index 100% rename from pythonapi/services.rst rename to old/pythonapi/services.rst diff --git a/pythonapi/tangible.rst b/old/pythonapi/tangible.rst similarity index 100% rename from pythonapi/tangible.rst rename to old/pythonapi/tangible.rst diff --git a/pythonapi/utility.rst b/old/pythonapi/utility.rst similarity index 100% rename from pythonapi/utility.rst rename to old/pythonapi/utility.rst diff --git a/tools/cmake/FindSphinx.cmake b/old/tools/cmake/FindSphinx.cmake similarity index 100% rename from tools/cmake/FindSphinx.cmake rename to old/tools/cmake/FindSphinx.cmake diff --git a/tools/windows/user_project.vcxproj.in b/old/tools/windows/user_project.vcxproj.in similarity index 100% rename from tools/windows/user_project.vcxproj.in rename to old/tools/windows/user_project.vcxproj.in