diff --git a/Apps/README.md b/Apps/README.md index ae75392f..0af1e835 100755 --- a/Apps/README.md +++ b/Apps/README.md @@ -1,9 +1,9 @@ # Apps -Here is a quick list of apps that are generally good to use and can come in handy in day to day tasks. I have seperated the apps into 4 broad categories Developer Tools, Productivity Tools, Office Apps and Others. +Here is a quick list of apps that are generally good to use and can come in handy in day to day tasks. The apps are seperated into 4 broad categories Developer Tools, Productivity Tools, Office Apps and Others. ### Developer Tools -- [Google Chrome](https://www.google.com/intl/en/chrome/browser/): Installs Chrome which I feel is the best browser currently. All chrome browsers and extensions are saved by Google so can be synced easily. +- [Google Chrome](https://www.google.com/intl/en/chrome/browser/): Installs Chrome which is one of the best browsers currently. All chrome browsers and extensions are saved by Google so can be synced easily. - [Latexian](http://tacosw.com/latexian/): App for writing Latex documents. View the code and output on split screen. Supports all major packages and code completion , etc. - [Valentina Studio](http://www.valentina-db.com/en/valentina-studio-overview): Valentina Studio is a gui to create, administer and query MySQL, Postgres and SQLite databases. @@ -14,9 +14,9 @@ Here is a quick list of apps that are generally good to use and can come in hand - [Spectacle](http://spectacleapp.com/): Don't waste time resizing and moving your windows. Spectacle makes this very easy and is open source. - [Unarchiver](http://wakaba.c3.cx/s/apps/unarchiver.html): Compress/Uncompress app. Supported file formats include Zip, Tar-GZip, Tar-BZip2, RAR, 7-zip, LhA, StuffIt and many other old and obscure formats. - [Total Finder](http://totalfinder.binaryage.com/): Adds tabs and improves the Finder to a great deal. -- [Dropbox](https://www.dropbox.com/): File syncing to the cloud. I put all my documents in Dropbox. It syncs them to all my devices (laptop, mobile, tablet), and serves as a backup as well! -- [Google Drive](https://drive.google.com/): File syncing to the cloud too! I use Google Docs a lot to collaborate with others. -- [PDF Toolkit+](https://itunes.apple.com/us/app/pdf-toolkit-+/id545164971?mt=12): App to cut/split/merge pdfs easily. One of the best apps I have ever seen. +- [Dropbox](https://www.dropbox.com/): File syncing to the cloud. It syncs files across all devices (laptop, mobile, tablet), and serves as a backup as well! +- [Google Drive](https://drive.google.com/): File syncing to the cloud too! Google Docs is a popular too to collaborate with others. +- [PDF Toolkit+](https://itunes.apple.com/us/app/pdf-toolkit-+/id545164971?mt=12): App to cut/split/merge pdfs easily. Really easy to use and works well. - [AppCleaner](http://www.freemacsoft.net/appcleaner/): Uninstall Apps. - [Notebooks](http://www.notebooksapp.com/mac/): Notebooks for Mac allows you to share files with the mobile versions of Notebooks on the iPad and iPhone. And you can write notes in markdown. - [Timing](http://timingapp.com/): Keep track of the time you spend with your Mac. @@ -31,7 +31,7 @@ Here is a quick list of apps that are generally good to use and can come in hand - [Numbers](http://www.apple.com/mac/numbers/): Create spreadsheets on mac, this is supposed to be an alternate to Excel. ### Others -- [SuperDuper](http://www.shirt-pocket.com/SuperDuper/SuperDuperDescription.html): Take backups of your disk and use the backup disk to restore the machine incase of failure. SuperDuper is much better than time machine in my opinion. +- [SuperDuper](http://www.shirt-pocket.com/SuperDuper/SuperDuperDescription.html): Take backups of your disk and use the backup disk to restore the machine incase of failure. - [Google Voice and Video](http://www.google.com/+/learnmore/hangouts/): A voice and video chat plugin. Not sure if this is required after the release of hangouts. - [Asepsis](http://asepsis.binaryage.com/): Get rid of the annoying DS_Store files. It stops them from being created anywhere on the system. - [Voila](http://www.globaldelight.com/voila/): Record your screen with audio, mouse highlight and other features. diff --git a/Git/README.md b/Git/README.md index 7b8f46d4..2de684b6 100644 --- a/Git/README.md +++ b/Git/README.md @@ -1,4 +1,4 @@ -# Git +# Git and Github What's a developer without [Git](http://git-scm.com/)? To install, simply run: @@ -21,4 +21,27 @@ To push code to your GitHub repositories, we're going to use the recommended HTT $ git config --global credential.helper osxkeychain +**Note**: This might be difficult to configure in case you have two factor authentication enabled. Please use the SSH config in that case. + +Setting up SSH is really simple as well. Most of the instructions below are referenced from [here](https://help.github.com/articles/generating-ssh-keys). + +First, we need to check for existing SSH keys on your computer. Open up your Terminal and type: + + $ cd ~/.ssh + $ ls -al + # Lists the files in your .ssh directory + +Check the directory listing to see if you have files named either id_rsa.pub or id_dsa.pub. If you don't have either of those files go to step 2. Otherwise, you can skip to step 3. + +Second, To generate a new SSH key, copy and paste the text below, making sure to substitute in your email. The default settings are preferred, so when you're asked to "enter a file in which to save the key,"" just press enter to continue. + + $ ssh-keygen -t rsa -C "your_email@example.com" + # Creates a new ssh key, using the provided email as a label + # Generating public/private rsa key pair. + # Enter file in which to save the key (/Users/you/.ssh/id_rsa): [Press enter] + +Please use a strong passphrase for your keys. + +Third, Add your keys to Github by going into account settings. + **Note**: On a Mac, it is important to remember to add `.DS_Store` (a hidden OS X system file that's put in folders) to your `.gitignore` files. \ No newline at end of file diff --git a/Python/virtualenv.md b/Python/virtualenv.md index 934de3dd..9939deb9 100644 --- a/Python/virtualenv.md +++ b/Python/virtualenv.md @@ -37,7 +37,7 @@ To leave the virtual environment use. **Important**: Remember to add `venv` to your project's `.gitignore` file so you don't include all of that in your source code! -I like to install big packages (like Numpy), or packages I always use (like IPython) globally. All the rest I install in a virtualenv. +It is preferable to install big packages (like Numpy), or packages you always use (like IPython) globally. All the rest can be installed in a virtualenv. ### Virtualenvwrapper For easier management of different virtual environments for multiple packages. Installing Virtualenv Wrapper is possible. For installation instructions read the [virtualenvwrapper](http://virtualenvwrapper.readthedocs.org/en/latest/index.html) documents here. diff --git a/README.md b/README.md index 83f6ec10..6708997d 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,12 @@ Mac OS X Setup Guide ==================== -This book will teach you the basics of setting up your developer environment on a new MacBook. I have tried these on Mountain Lion and Mavericks but they might be more inclined towards Mavericks. Whether you are an experienced programmer or not, this book is intended for everyone to use as a reference when installing some language/library. +This book covers the basics of setting up development environment on a new MacBook for most major languages. All instructions covered have been tried on Mountain Lion and Mavericks but they might be more inclined towards Mavericks. Whether you are an experienced programmer or not, this book is intended for everyone to use as a reference when installing some language/library. [![Screen](https://raw.githubusercontent.com/sb2nov/mac-setup/master/assets/intro.jpeg)](https://raw.githubusercontent.com/sb2nov/mac-setup/master/assets/intro.jpeg) -We will set up [Node](http://nodejs.org/) (JavaScript), [Python](http://www.python.org/), [CPlusPlus](http://www.cplusplus.com/), and [Ruby](http://www.ruby-lang.org/) environments, mainly for JavaScript and Python development. Even if you don't program in all three, it is good to have them as many command-line tools use one of them. We also install a few daily use application and Latex. As you read and follow these steps, feel free to send me any feedback or comments you may have. +We will set up [Node](http://nodejs.org/) (JavaScript), [Python](http://www.python.org/), [CPlusPlus](http://www.cplusplus.com/), and [Ruby](http://www.ruby-lang.org/) environments. Even if you don't program in all three, it is good to have them as many command-line tools use one of them. We also install a few daily use application and Latex. As you read and follow these steps, feel free to send me any feedback or comments you may have. + +All contributions to the book are welcome. Please help add support for other libraries and languages. **Note:** This book has been generated using [GitBook](http://www.gitbook.io) and is open source, feel free to contribute or signal issues on [GitHub](https://github.com/sb2nob/mac-setup). diff --git a/References/README.md b/References/README.md new file mode 100644 index 00000000..cfe6cdf0 --- /dev/null +++ b/References/README.md @@ -0,0 +1,13 @@ +# Credits & References + +Thank you for all the awesome pages and documentation below that helped set this up. + +- [Nicolashery](https://github.com/nicolashery/mac-dev-setup) +- [Github](https://help.github.com/articles) +- [Gitbook](https://github.com/GitbookIO/gitbook) +- [Sublime Plugins](https://sublime.wbond.net/) + + +# Contributing + +Please feel free to send [Pull Requests](https://github.com/sb2nov/mac-setup/pulls) fixing any mistakes in the book or adding additional information. diff --git a/SUMMARY.md b/SUMMARY.md index b41c66a7..fb2b960b 100755 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -23,3 +23,4 @@ * [Latex](Latex/README.md) * [Apps](Apps/README.md) * [Settings](Apps/Settings.md) +* [References](References/README.md) diff --git a/SublimeText/Preferences.md b/SublimeText/Preferences.md index 608468b0..d50d6502 100644 --- a/SublimeText/Preferences.md +++ b/SublimeText/Preferences.md @@ -1,6 +1,6 @@ # Preferences -I prefer these User Settings for my development but please feel free to modify or update as per your choice. +This is an example of User Settings for a basic development but please feel free to modify or update as per your choice. ~~~ { diff --git a/SublimeText/README.md b/SublimeText/README.md index f7e2c341..7cedcf4b 100755 --- a/SublimeText/README.md +++ b/SublimeText/README.md @@ -6,10 +6,10 @@ Go ahead and [download](http://www.sublimetext.com/) it. Open the **.dmg** file, **Note**: At this point I'm going to create a shorcut on the OS X Dock for both for Sublime Text and iTerm. To do so, right-click on the running application and select **Options > Keep in Dock**. -Sublime Text is not free, but I think it has an unlimited "evaluation period". Anyhow, we're going to be using it so much that even the seemingly expensive $60 price tag is worth every penny. If you can afford it, I suggest you [support](http://www.sublimetext.com/buy) this awesome tool. :) +Sublime Text is not free, but it has an unlimited "evaluation period". Anyhow, we're going to be using it so much that even the seemingly expensive $60 price tag is worth every penny. If you can afford it, It is adviced that you [support](http://www.sublimetext.com/buy) this awesome tool. :) Let's create a shortcut so we can launch Sublime Text from the command-line: $ ln -s /Applications/Sublime\ Text.app/Contents/SharedSupport/bin/subl /usr/local/bin/subl -Now I can open a file with `$ subl myfile.py` or start a new project in the current directory with `$ subl .`. Pretty cool. We'll configure Sublime more in the next few sections. +Now you can open a file with `$ subl myfile.py` or start a new project in the current directory with `$ subl .`. Pretty cool. We'll configure Sublime more in the next few sections. diff --git a/SystemPreferences/README.md b/SystemPreferences/README.md index 08474efa..1b840b56 100644 --- a/SystemPreferences/README.md +++ b/SystemPreferences/README.md @@ -1,9 +1,9 @@ # System Preferences First thing you need to do, on any OS acutally, is update the system! For that: **Apple Icon > Software Update.** -Also upgrade your OS incase you got a machine with **Lion** installed on it. I got a free upgrade as I had purchased my machine after the Mountain Lion launch. +Also upgrade your OS incase you want to work on the latest OS. Mavericks is a free upgrade so please check that. -If this is a new computer, there are a couple tweaks I like to make to the System Preferences. Feel free to follow these, or to ignore them, depending on your personal preferences. +If this is a new computer, there are a couple tweaks you would like to make to the System Preferences. Feel free to follow these, or to ignore them, depending on your personal preferences. ### Users and Groups - Login Options-> Change fast switching user menu to Icon @@ -23,7 +23,7 @@ If this is a new computer, there are a couple tweaks I like to make to the Syste ### Finder - Toolbar - Update to add path, new folder and delete -- Sidebar +- Sidebar - Add home and code directory - Remove shared and tags - New finder window to open in the home directory diff --git a/assets/Iterm.png b/assets/Iterm.png new file mode 100644 index 00000000..38e07069 Binary files /dev/null and b/assets/Iterm.png differ diff --git a/iTerm/README.md b/iTerm/README.md index c56d83f3..8f933458 100644 --- a/iTerm/README.md +++ b/iTerm/README.md @@ -14,3 +14,7 @@ Let's just quickly change some preferences. - Download the [Solarized dark iterm colors](https://github.com/altercation/solarized/tree/master/iterm2-colors-solarized) from here. And then set these to your default profile colors. - Change the cursor text and cursor color to yellow make it more visible - Change the font to 14pt Source Code Pro Lite. Source Code Pro can be downloaded from [here](https://github.com/adobe/source-code-pro/downloads). + + +[![Screen](https://raw.githubusercontent.com/sb2nov/mac-setup/master/assets/iterm.png)](https://raw.githubusercontent.com/sb2nov/mac-setup/master/assets/iterm.png) + diff --git a/package.json b/package.json index be044ed0..3b8ef0d9 100755 --- a/package.json +++ b/package.json @@ -28,7 +28,8 @@ "grunt": "0.4.1", "grunt-contrib-clean": "~0.5.0", "grunt-gh-pages": "0.9.1", - "grunt-gitbook": "0.2.3" + "grunt-gitbook": "0.2.3", + "grunt-http-server": "0.0.5" }, "peerDependencies": { "grunt": "0.4.1"