135
edits
Changes
Jump to navigation
Jump to search
Line 13:
Line 13: − + Line 28:
Line 28: − − ===Installing SVN=== − You will need SVN software to use the SSI Altium repository. The recommended choice is to install [http://tortoisesvn.net/ Tortoise SVN] (Windows-only). There are solutions for Mac and Linux users as well, though none quite as streamlined as TortoiseSVN; many Linux and Max users use the command line (Terminal) to handle SVN. − − TortoiseSVN will run persistently on your computer and allow you to work with files synchronized with the SVN. As shown at right, TortoiseSVN will appear as a menu available when right clicking on files or folders. We will introduce the most useful of these commands in this article; several more are discussed [[Using TortoiseSVN|here]] (recommended reading ''after'' completing this guide). − − ===Downloading SSI Altium SVN=== − [[File:SVNCheckout.png|thumb|200px|right|Make sure you're right clicking on the folder you just created.]] − [[File:SVNCheckout2.png|thumb|200px|right|Your checkout window should look very similar to this.]] − Find a convenient location on your computer (i.e. your desktop) to create a folder that will host all of the shared SSI Altium files. Create a new folder there (my folder is called "SVN-SSI-Altium," though "altium-core" is what the folder is called on the server). Right click on the folder, and select "SVN Checkout" (see right). A window should pop up (see right) showing a URL to download files from and a location on your computer where the files will be downloaded. Verify that the target on your computer is where you intend and set the URL of the repository to {{altium-repo}}, and click OK. You will then likely be prompted for your SVN login - this will be your '''username''' and password Slacked to you after you requested them. You do not need credentials to download the libraries on campus, but you do need credentials to push changes to the libraries (regardless of where you are). Enter credentials if you have them, click OK, and your computer should begin to download the Altium libraries. These should take less than a minute to download on campus. Line 64:
Line 54: − ==A Brief Introduction to SVN== − This is the last part of this guide! You have actually already completed the installation and configuration of Altium; this step is intended to give you a quick introduction to SVN and how to use it. You will not need Altium for this last step; if you're completing this tutorial at a time when others are likely to also be working through it, close Altium, as that will free up licenses for others to use. If you're already familiar with SVN, skip to the [[#Your First Commit|last task]]. − + + + + + + + + + + + + + + + + + + + + + Line 87:
Line 95: − − '''You're done!''' Welcome to Altium! − − ==Next Steps== − − ;A First Project :[[Your First Altium Project|This (currently in-development) guide]] offers you a walkthrough of a fun introductory Altium project, which ends with making a circuit board that allows you to play StrEEt Fighter with your fellow SSI members. − ;Creating Parts for Altium Libraries : [[Making Parts for PCB Libraries|This guide]] walks you through the process of adding new parts to the SSI Altium library, teaching both the process involved and quality standards for the library that we and the Stanford Solar Car Project have long worked to maintain.
How to Install and Configure Altium (view source)
Revision as of 05:03, 23 August 2022
, 05:03, 23 August 2022no edit summary
* All new projects are stored on Github. An example of this is [https://github.com/stanford-ssi/ThunderGuppy-EE ThunderGuppy-EE]. All SSI projects should be public on the [https://github.com/stanford-ssi SSI Github], but in order to commit changes, you're going to need to [https://github.com/join create a Github Account] and have someone add you as a member of the SSI Github organization. Ask in {{slack-channel|git}} to be added.
* All new projects are stored on Github. An example of this is [https://github.com/stanford-ssi/ThunderGuppy-EE ThunderGuppy-EE]. All SSI projects should be public on the [https://github.com/stanford-ssi SSI Github], but in order to commit changes, you're going to need to [https://github.com/join create a Github Account] and have someone add you as a member of the SSI Github organization. Ask in {{slack-channel|git}} to be added.
* All components and parts live on the [https://stanford-university-student-space-initiative.365.altium.com/ Altium 365 workspace]. To access this you will need an Altium account connected to your Stanford email, and you will need to be added to the workspace. You should ask for these things in {{slack-channel|altium}}, and tag the {{slack-user|altium-admin}}.
* All components and parts live on the [https://stanford-university-student-space-initiative.365.altium.com/ Altium 365 workspace]. To access this you will need an Altium account connected to your Stanford email, and you will need to be added to the workspace. You should ask for these things in {{slack-channel|altium}}, and tag the {{slack-user|sunet-id=altium-admin|display-name=altium-admin}}.
* Templates, Logos, Fonts, and oddball SSI-wide data lives in the [https://ssi-svn.stanford.edu/svn/altium-core/ Altium SVN]. SVN ([https://subversion.apache.org/ Subversion]) is the grandfather to Git and Google Drive. To access the SVN you need credentials which you can get from https://ssi-svn.stanford.edu/ and an SVN client, like [https://tortoisesvn.net/ TortoiseSVN].
* Templates, Logos, Fonts, and oddball SSI-wide data lives in the [https://ssi-svn.stanford.edu/svn/altium-core/ Altium SVN]. SVN ([https://subversion.apache.org/ Subversion]) is the grandfather to Git and Google Drive. To access the SVN you need credentials which you can get from https://ssi-svn.stanford.edu/ and an SVN client, like [https://tortoisesvn.net/ TortoiseSVN].
[[File:TortoiseSVNMenu.png|thumb|200px|right|A screenshot showing all of the SVN functions available when right-clicking after installing TortoiseSVN. You will never use most of these.]]
[[File:TortoiseSVNMenu.png|thumb|200px|right|A screenshot showing all of the SVN functions available when right-clicking after installing TortoiseSVN. You will never use most of these.]]
Within the {{slack-channel|altium}} channel, request an account for Altium itself, the Altium365 workspace, and the SVN. Messaging {{slack-user|sunet-id=altium-admin|display-name=altium-admin}} will summon the relevant person.
Within the {{slack-channel|altium}} channel, request an account for Altium itself, the Altium365 workspace, and the SVN. Messaging {{slack-user|sunet-id=altium-admin|display-name=altium-admin}} will summon the relevant person.
===Installing Altium===
===Installing Altium===
If you do not have a schematic open already, open one by clicking "File → New → Schematic." Next, open up the Customize panel by either clicking on a blank space of the toolbar (the space to the right of the "Help" drop-down menu works) or by right-clicking in that same spot and selecting "Customize..." In the window that comes up (see right), click "Edit" from the "Categories" column on the left, then double click on "Delete" in the "Commands" column on the right. This is the command used to delete components from a schematic, which is by default mapped to the delete key, which, if you're completing this step, you do not have. Click the "Primary" field, and then hit your backspace key to remap the command to that key. This only changes the delete key for schematics, so repeat this process with a PCB document open.
If you do not have a schematic open already, open one by clicking "File → New → Schematic." Next, open up the Customize panel by either clicking on a blank space of the toolbar (the space to the right of the "Help" drop-down menu works) or by right-clicking in that same spot and selecting "Customize..." In the window that comes up (see right), click "Edit" from the "Categories" column on the left, then double click on "Delete" in the "Commands" column on the right. This is the command used to delete components from a schematic, which is by default mapped to the delete key, which, if you're completing this step, you do not have. Click the "Primary" field, and then hit your backspace key to remap the command to that key. This only changes the delete key for schematics, so repeat this process with a PCB document open.
===Background===
'''You're done!''' Welcome to Altium!
==Next Steps==
;A First Project :[[Your First Altium Project|This (currently in-development) guide]] offers you a walkthrough of a fun introductory Altium project, which ends with making a circuit board that allows you to play StrEEt Fighter with your fellow SSI members.
;Creating Parts for Altium Libraries : [[Making Parts for PCB Libraries|This guide]] walks you through the process of adding new parts to the SSI Altium library, teaching both the process involved and quality standards for the library that we and the Stanford Solar Car Project have long worked to maintain.
==Addendum: SVN==
===Installing SVN===
You will need SVN software to use the SSI Altium repository. The recommended choice is to install [http://tortoisesvn.net/ Tortoise SVN] (Windows-only). There are solutions for Mac and Linux users as well, though none quite as streamlined as TortoiseSVN; many Linux and Max users use the command line (Terminal) to handle SVN.
TortoiseSVN will run persistently on your computer and allow you to work with files synchronized with the SVN. As shown at right, TortoiseSVN will appear as a menu available when right clicking on files or folders. We will introduce the most useful of these commands in this article; several more are discussed [[Using TortoiseSVN|here]] (recommended reading ''after'' completing this guide).
===Downloading SSI Altium SVN===
[[File:SVNCheckout.png|thumb|200px|right|Make sure you're right clicking on the folder you just created.]]
[[File:SVNCheckout2.png|thumb|200px|right|Your checkout window should look very similar to this.]]
Find a convenient location on your computer (i.e. your desktop) to create a folder that will host all of the shared SSI Altium files. Create a new folder there (my folder is called "SVN-SSI-Altium," though "altium-core" is what the folder is called on the server). Right click on the folder, and select "SVN Checkout" (see right). A window should pop up (see right) showing a URL to download files from and a location on your computer where the files will be downloaded. Verify that the target on your computer is where you intend and set the URL of the repository to {{altium-repo}}, and click OK. You will then likely be prompted for your SVN login - this will be your '''username''' and password Slacked to you after you requested them. You do not need credentials to download the libraries on campus, but you do need credentials to push changes to the libraries (regardless of where you are). Enter credentials if you have them, click OK, and your computer should begin to download the Altium libraries. These should take less than a minute to download on campus.
===A Brief Introduction to SVN===
An SVN repository is a series of "snapshots" of a folder over time. Each snapshot is called a '''commit''', and represents the state of the folder and some or all of its contents at a moment in time. Commits are created by users (aka you) when they want to preserve a version of the files they are working on - this typically happens after making a group of changes to files stored in the SVN repository (ie. after adding a part to a library or making progress on a circuit schematic or circuit board).
An SVN repository is a series of "snapshots" of a folder over time. Each snapshot is called a '''commit''', and represents the state of the folder and some or all of its contents at a moment in time. Commits are created by users (aka you) when they want to preserve a version of the files they are working on - this typically happens after making a group of changes to files stored in the SVN repository (ie. after adding a part to a library or making progress on a circuit schematic or circuit board).
To finish, go back to your Altium SVN folder, right click while ''not'' on any file or folder, and mouse down to "SVN Commit..." and click it. A dialog box will come up (see right), at the bottom of which should be a list of files. This shows files you have changed since the last time you ran SVN update, and ''should'' just have iwuzhere.txt listed. Make sure you have it checked. In the text box at the top of the window, you will need to write a '''commit message''', a brief description of what changes you're committing. This message will appear in Slack and must be at least 20 characters (but shouldn't be longer than a single sentence). Once you've written it, click okay, and wait for a message to appear in Slack.
To finish, go back to your Altium SVN folder, right click while ''not'' on any file or folder, and mouse down to "SVN Commit..." and click it. A dialog box will come up (see right), at the bottom of which should be a list of files. This shows files you have changed since the last time you ran SVN update, and ''should'' just have iwuzhere.txt listed. Make sure you have it checked. In the text box at the top of the window, you will need to write a '''commit message''', a brief description of what changes you're committing. This message will appear in Slack and must be at least 20 characters (but shouldn't be longer than a single sentence). Once you've written it, click okay, and wait for a message to appear in Slack.
[[Category: Altium]]
[[Category: Altium]]