Getting Set Up to Contribute

From PCGen
Jump to: navigation, search

IN PROGRESS

STEP 1: Required Tools (Basic Set Up)

You'll need to download git -- https://git-scm.com/downloads









This assumes Windows as the operating system. Adapt to make work for other systems.

in the C drive create a new folder called "Projects", inside that folder create another called "pcgen".

c:\Projects\pcgen


RAW

[11:53 AM] Andrew Maitland: I'll set you up like I am, feel free to ignore locations, but this set up works for me... [11:53 AM] Andrew Maitland: C drive [11:53 AM] Andrew Maitland: Create folder named "Projects" [11:53 AM] Andrew Maitland: Inside that create folder "PCGen" [11:54 AM] Omowale Anthony: ok [11:54 AM] Andrew Maitland: Download this and install: https://git-scm.com/downloads [11:55 AM] Andrew Maitland: and then either this: https://tortoisegit.org/ [11:55 AM] Andrew Maitland: or [11:55 AM] Andrew Maitland: https://www.sourcetreeapp.com/ [11:56 AM] Andrew Maitland: Both are git clients, one is shell integration, the other is a GUI program. I use TortoiseGIT [11:56 AM] Andrew Maitland: You can use them both, doesn't matter. I'll be providing guidance based upon TortoiseGIT though [11:57 AM] Omowale Anthony: ok [11:57 AM] Andrew Maitland: Sign up for an account at github.com [11:58 AM] Andrew Maitland: After you sign up, go into settings > Drop Down option TOP RIGHT CORNER [11:58 AM] Andrew Maitland: SSH and GPG keys [11:59 AM] Andrew Maitland: Add new SSH key [11:59 AM] Andrew Maitland: --- Is tortoisegit installed yet? [12:02 PM] Omowale Anthony: going through the part after install now [12:03 PM] Andrew Maitland: ok, let me know when you've reached this point [12:04 PM] Omowale Anthony: i'm at add a new key and done with tortoise [12:04 PM] Andrew Maitland: okay, Start Menu > Find TortoiseGIT and open PuttyGen [12:05 PM] Andrew Maitland: Click Generate, and wiggle that mouse around [12:06 PM] Andrew Maitland: Once key is made, save > Private Key to My Documents in "Keys" folder [12:06 PM] Omowale Anthony: passphrase? [12:06 PM] Andrew Maitland: leave everything blank... no passphrase [12:07 PM] Omowale Anthony: ok [12:07 PM] Omowale Anthony: do i need to name it anything in particular [12:08 PM] Andrew Maitland: pcgen key if you'd like [12:08 PM] Omowale Anthony: ok [12:08 PM] Andrew Maitland: Copy the key contents and paste those on the github site - where the New Key is waiting [12:09 PM] Omowale Anthony: done [12:09 PM] Andrew Maitland: ok [12:10 PM] Andrew Maitland: https://github.com/PCGen/pcgen-newsources [12:10 PM] Andrew Maitland: the green download or clone button [12:10 PM] Andrew Maitland: click the clipboard icon to save the link [12:10 PM] Andrew Maitland:

   git@github.com:PCGen/pcgen-newsources.git

[12:10 PM] Andrew Maitland: should look like that [12:11 PM] Omowale Anthony: got it [12:12 PM] Andrew Maitland: in the windows - pcgen folder, RIGHT CLICK. TortoiseGit > Clone Repo [12:12 PM] Andrew Maitland: erm, Git Clone [12:12 PM] Andrew Maitland: The URL should auto populate [12:12 PM] Andrew Maitland: with that link. [12:13 PM] Andrew Maitland: Directory should auto populate with C:\Projects\pcgen\pcgen-newsources [12:13 PM] Omowale Anthony: yes it did [12:13 PM] Andrew Maitland: Check Load PuttyKey, and then populate the link with the path to your new private key [12:14 PM] Omowale Anthony: got it [12:14 PM] Andrew Maitland: NOW - before I go past the point of no return. You are only going to be pulling information to play with. You have no intention now, or in the next six months of producing any books, correct? [12:15 PM] Andrew Maitland: If that statement is true. Click OK [12:16 PM] Andrew Maitland: and watch as all the pcgen goodness flows onto your computer [12:16 PM] Omowale Anthony: hmm...what kind of books? I am in the process of gathering the info and skeleton for a book...i don't know about six months though [12:17 PM] Andrew Maitland: Adding books to pcgen through the normal process [12:18 PM] Andrew Maitland: i.e. coding in lst and adding it [12:18 PM] Andrew Maitland: the difference is whether I get you your own repo or we set you up to access the repo directly [12:18 PM] Omowale Anthony: oh ok...no i do not...i'm talking fantasy novel [12:18 PM] Andrew Maitland: Okay, hit OK, and enjoy the download [12:19 PM] Omowale Anthony: 8-) [12:20 PM] Andrew Maitland: Now, if you want to be the king of cool... building pcgen so you aren't downloading the zips and moving files constantly.... [12:20 PM] Andrew Maitland: up to you [12:21 PM] Omowale Anthony: hmm...that does sound pretty cool...i've taken up so much of your time already [12:21 PM] Andrew Maitland: It shouldn't take more than 5 - 10 minutes [12:22 PM] Omowale Anthony: okay...does pcgen need to be installed or does just the unzipped folder work? [12:22 PM] Andrew Maitland: No, nothings needs to be installed. [12:23 PM] Andrew Maitland: we could leave this as is, and set up pcgen to load those new sets with just a couple of clicks and location entry [12:23 PM] Andrew Maitland: but I think it'd be easier on you to just make pcgen in one location so you aren't reconfiguring every release [12:25 PM] Omowale Anthony: sounds good to me [12:25 PM] Omowale Anthony: download complete [12:25 PM] Andrew Maitland: okay, same deal - right click in in the PCGEN folder we are in [12:25 PM] Andrew Maitland: Git Clone [12:25 PM] Andrew Maitland:

   git@github.com:PCGen/pcgen.git

[12:25 PM] Andrew Maitland: that's the URL [12:26 PM] Andrew Maitland: folder should change to pcgen [12:26 PM] Andrew Maitland: use the same key [12:26 PM] Andrew Maitland: click OK [12:27 PM] Omowale Anthony: add server key to cache? [12:27 PM] Andrew Maitland: Add your private key to the PuttyKey link, just like we did last time