# Team BDJ'); DROP TABLE TEAMS; - -

# Project: OpenCV

## ACTIVITY LOG
| Date | Description |
| -------- | -------- |
| 5/1/2020 | Dropped Atom
| 5/2/2020 | Reviewed several open source projects, namely Pandas, Scikit-Learn, Arduino, Python-DS |
| 5/2/2020 | Decided on OpenCV for moving forward. |
| 5/2/2020 | Started an issue, tutorial, documentation and contributing documents review "blitz" |
| 5/3/2020 | Discussed next steps in installation and tutorial editing/merging/enhancement. |
| 5/3/2020 | Opened issue [17212](https://github.com/opencv/opencv/issues/17212) on broken numpy links. |
| 5/4/2020 | (D) Reviewed contributing documents. |
| 5/4/2020 | (D) Sent e-mail regarding corrections to OpenCV [About Page](https://opencv.org/about/) |
| 5/4/2020 | (D) Set up development environment. |
| 5/4/2020 | Pull request submitted re 17212. |
| 5/4/2020 | Pull request submitted re MathJax link (no issue opened) |
| 5/4/2020 | Issue submitted on git precommit hook commands. |
| 5/5/2020 | Submitted pull request for imgproc tutorials table of contents |
| 5/5/2020 | Started research on Contour Articles |
| 5/6/2020 | Squashed commits for PR[#17223](https://github.com/opencv/opencv/pull/17223) |
| 5/8/2020 | Updated Hunter fork of OpenCV. |
| 5/8/2020 | Pull request submitted re tutorials tables of content. |
| 5/8/2020 | Submitted issue [#17245](https://github.com/opencv/opencv/issues/17245) regarding consolidating contours tutorials. |
| 5/17/2020 | Submitted issue [#17312](https://github.com/opencv/opencv/issues/17312) regarding the Random generator tutorial. |
| 5/17/2020 | Submitted PR[#17313](https://github.com/opencv/opencv/pull/17313) regarding Python kNN tutorials|
| 5/17/2020 | Submitted issue [#17315](https://github.com/opencv/opencv/issues/17315) regarding Out of Focus Deblur tutorial code. |
| 5/19/2020 | Submitted PR[#17325](https://github.com/opencv/opencv/pull/17325) adding navigation links to tutorials. |

## Issue Draftin' 📝

## ON DECK
- [Join Slack?](https://open-cv.slack.com/join/shared_invite/zt-59r70dt1-iG2WZ3gG2WbnMnGZEYfcSQ#/)
- Review other about pages? There is [Android](https://opencv.org/android/) for one, which seems to link to an older version of the documentation.
- Read [Python Contours](https://docs.opencv.org/master/d3/d05/tutorial_py_table_of_contents_contours.html) Article Section && develop ideas for commenting/restructuring/porting to main articles on contours

## We Got Issues 😂

### In Progress
| Issue/PR | Status | Description | Notes |
|:--------:|:--------:|:-------- |:-------- |
| N/A | Email Sent. | Bad link to "label:easy" issues and bad "Bug Reports link" on About page. May also include grammar: "Company Can" to "Companies Can". Inconsistency in introduction regarding # of algorithms. Community size grammar in introduction. | [About Page](https://opencv.org/about/) |
| Issue[#17245](https://github.com/opencv/opencv/issues/17245) | Pending. | Consolidating Contours Tutorials | See [contours consolidation](##Contours-Consolidation) |
| Issue [#17315](https://github.com/opencv/opencv/issues/17315) | Conversation in progress. | Issue with out of focus deblur tutorial and translation. | [Python Translated Code](https://github.com/hunter-college-ossd-spr-2020/opencv/blob/deblur-tutorial/samples/python/tutorial_code/imgProc/out_of_focus_deblur_filter/out_of_focus_deblur_filter.py) !! |
| PR[#17326](https://github.com/opencv/opencv/pull/17326) | Pending | Expand random generator and text tutorial with existing Python sample | |

### Resolved
| Issue/PR | Status | Description | Notes |
|:--------:|:--------:|:-------- |:-------- |
| Issue:[#17220](https://github.com/opencv/opencv/issues/17220) | Closed (Fixed) | Bad instructions for Git commit hook [here](https://github.com/opencv/opencv/wiki/How_to_contribute#q3-i-was-asked-to-remove-whitespace-issues-how-can-i-do-that). Relative path shouldn't work after cd. | |
| Issue[#17212](https://github.com/opencv/opencv/issues/17212), PR[#17218](https://github.com/opencv/opencv/pull/17218) | Merged :tada: | Broken NumPy links. | [Source File](https://github.com/opencv/opencv/blob/master/doc/py_tutorials/py_setup/py_intro/py_intro.markdown) |
| PR[#17219](https://github.com/opencv/opencv/pull/17219) | Merged :tada: | Broken link for MathJax - should probably be [this]( http://docs.mathjax.org/en/latest/input/tex/macros/index.html) - on ["Writing documentation for OpenCV"](https://docs.opencv.org/master/d4/db1/tutorial_documentation.html) | [Source File](https://github.com/opencv/opencv/blob/master/doc/tutorials/introduction/documenting_opencv/documentation_tutorial.markdown) |
| PR[#17223](https://github.com/opencv/opencv/pull/17223) | Merged :tada: | Updates table of contents for the imgproc module tutorials. | [Source File](https://github.com/opencv/opencv/blob/3.4/doc/tutorials/imgproc/table_of_content_imgproc.markdown) |
| PR[#17244](https://github.com/opencv/opencv/pull/17244) | Merged :tada: | Update tutorials tables of content for multiple modules. | |
| PR[#17313](https://github.com/opencv/opencv/pull/17313) | Merged :tada: | Revise and expand kNN Python tutorials |
| PR[#17325](https://github.com/opencv/opencv/pull/17325) | Merged :tada: | Adds navigation links to all main tutorials |

## CONTRIBUTING Documents
| Name | Notes |
| -------- | -------- |
| [Contribute](https://opencv.org/about/#Contribute) | Section on About page laying out how to contribute. |
| [How_to_contribute](https://github.com/opencv/opencv/wiki/How_to_contribute) | We may need to pay particular attention to [this](https://github.com/opencv/opencv/wiki/How_to_contribute#q3-i-was-asked-to-remove-whitespace-issues-how-can-i-do-that) so as not to run into whitespace issues. |
| [Writing documentation for OpenCV](https://docs.opencv.org/master/d4/db1/tutorial_documentation.html) | |
| [Documentation improvement plan](https://github.com/opencv/opencv/wiki/Documentation-improvement-plan) | |
| [Coding_Style_Guide](https://github.com/opencv/opencv/wiki/Coding_Style_Guide)| Primarily concerned with C++ but does have notes on Python. |
| [Branches](https://github.com/opencv/opencv/wiki/Branches) | Document on working with OpenCV branches. |

## Issues of Note
| Issue # | Notes |
| -------- | -------- |
| [9520](https://github.com/opencv/opencv/issues/9520) | Issue on documentation improvement plan. |
| [15306](https://github.com/opencv/opencv/issues/15306) | Typescript efforts - unlikely but who knows. |
| [15583](https://github.com/opencv/opencv/issues/15583) | Creating an [Emscripten](https://emscripten.org/index.html) Port, also unlikely |

## General Tutorials
| Source File | Docs Link | Notes |
| -------- | -------- | -------- |
| [YOLO DNNs](https://github.com/opencv/opencv/blob/master/doc/tutorials/dnn/dnn_yolo/dnn_yolo.markdown) | [Link](https://docs.opencv.org/master/da/d9d/tutorial_dnn_yolo.html) | Highly incomplete, lengthy source code with no explanation |
| [Random generator and text with OpenCV](https://github.com/opencv/opencv/blob/master/doc/tutorials/imgproc/random_generator_and_text/random_generator_and_text.markdown) | [Link](https://docs.opencv.org/master/df/d61/tutorial_random_generator_and_text.html) | No Python code! RNG may not exist in Python? Can implement or make a note of this?|
| [Finding contours in your image](https://github.com/opencv/opencv/blob/master/doc/tutorials/imgproc/shapedescriptors/find_contours/find_contours.markdown) | [Link](https://docs.opencv.org/master/df/d0d/tutorial_find_contours.html) | Very incomplete!!! Split into [several sections](https://docs.opencv.org/master/d3/d05/tutorial_py_table_of_contents_contours.html) in Python Tutorials |
| [Convex Hull](https://github.com/opencv/opencv/blob/master/doc/tutorials/imgproc/shapedescriptors/hull/hull.markdown) | [Link](https://docs.opencv.org/master/d7/d1d/tutorial_hull.html) | Very incomplete!!! Mentioned in a [subsection](https://docs.opencv.org/master/dd/d49/tutorial_py_contour_features.html)(#5) of contours in Python Tutorials|
| [Out-of-focus Deblur Filter](https://github.com/opencv/opencv/blob/master/doc/tutorials/imgproc/out_of_focus_deblur_filter/out_of_focus_deblur_filter.markdown) | [Link](https://docs.opencv.org/master/de/d3c/tutorial_out_of_focus_deblur_filter.html) | No Python code! |
| [Motion Deblur Filter](https://github.com/opencv/opencv/blob/master/doc/tutorials/imgproc/motion_deblur_filter/motion_deblur_filter.markdown) | [Link](https://docs.opencv.org/master/d1/dfd/tutorial_motion_deblur_filter.html) | No Python code! |
| [Periodic Noise Removing Filter](https://github.com/opencv/opencv/blob/master/doc/tutorials/imgproc/periodic_noise_removing_filter/periodic_noise_removing_filter.markdown) | [Link](https://docs.opencv.org/master/d2/d0b/tutorial_periodic_noise_removing_filter.html) | No Python code! |
| [Stitcher](https://github.com/opencv/opencv/blob/3.4/doc/tutorials/stitching/stitcher/stitcher.markdown) | [Link](https://docs.opencv.org/3.4/d8/d19/tutorial_stitcher.html) | No Python code! |

## Tutorials to Possibly Merge
| Tutorials Link(s) | Python Tutorials Link(s) | Notes |
| -------- | -------- | -------- |
| [canny_detector](https://docs.opencv.org/master/da/d5c/tutorial_canny_detector.html) | [py_canny](https://docs.opencv.org/master/da/d22/tutorial_py_canny.html) | Almost direct overlap. Explanation for C++ code exists. |
| [Linux Install Tutorial](https://docs.opencv.org/master/d7/d9f/tutorial_linux_install.html) | [Ubuntu Install Tutorial](https://docs.opencv.org/master/d2/de6/tutorial_py_setup_in_ubuntu.html) | Linux Tutorial uses Ubuntu anyway, and is outdated (no mention of Python3). Building from source section in each should be consolidated together, with preference to the more up to date py tutorial. |
| [morph_lines_detection](https://docs.opencv.org/master/dd/dd7/tutorial_morph_lines_detection.html), [opening closing hats](https://docs.opencv.org/master/d3/dbe/tutorial_opening_closing_hats.html), [erosion_dilation](https://docs.opencv.org/master/db/df6/tutorial_erosion_dilatation.html) | [py_morphological_ops](https://docs.opencv.org/master/d9/d61/tutorial_py_morphological_ops.html) | The python tutorial has the parts from all the main tutorial articles, but with much less detail. The python should be incorporated and then after, morphological operations can be split into two sections if necessary. |
| [hough_lines](https://docs.opencv.org/master/d9/db0/tutorial_hough_lines.html) | [py_hough_lines](https://docs.opencv.org/master/d6/d10/tutorial_py_houghlines.html) | Direct overlap, will have to do some picking/choosing/editing to cleanly merge them |
| | | |

## Python Tutorials
| Tutorial Link | Live Link | Notes |
| -------- | -------- | -------- |
| [Understanding k-Nearest Neighbour](https://github.com/opencv/opencv/blob/master/doc/py_tutorials/py_ml/py_knn/py_knn_understanding/py_knn_understanding.markdown) | [Link](https://docs.opencv.org/master/d5/d26/tutorial_py_knn_understanding.html) | Grammar revisions |

## Documentation
| Documentation Name (Link) | Live Link | Notes |
| -------- | -------- | -------- |
| | | |

## Contours Consolidation
### doc/py_tutorials/py_imgproc/py_contours/
[Contours : Getting Started](https://docs.opencv.org/3.4/d4/d73/tutorial_py_contours_begin.html) - cv.findContours(), cv.drawContours()

[Contour Features](https://docs.opencv.org/3.4/dd/d49/tutorial_py_contour_features.html) - cv.moments(), cv.contourArea(), cv.arcLength(), **cv.approxPolyDP()**, cv.convexHull, cv.isContourConvex(), cv.boundingRect(), cv.minEnclosingCircle(), cv.fitEllipse(), cv.fitLine()

[Contour Properties](https://docs.opencv.org/3.4/d1/d32/tutorial_py_contour_properties.html) - Implementation examples for common img properties, no new contour functions

[Contours : More Functions](https://docs.opencv.org/3.4/d5/d45/tutorial_py_contours_more_functions.html) - cv.convexityDefects(), cv.pointPolygonTest(), cv.matchShapes(), cv.HuMoments() (*HuMoments only mentioned in note in passing*)

[Contours Hierarchy](https://docs.opencv.org/3.4/d9/d8b/tutorial_py_contours_hierarchy.html) - Explanation of Contour Retrieval Mode flag parameter in cv.findContours()

### doc/tutorials/imgproc/shapedescriptors/
*Note the below also have Python code!*
[Finding contours in your image](https://docs.opencv.org/3.4/df/d0d/tutorial_find_contours.html) - cv::findContours, cv::drawContours

[Convex Hull](https://docs.opencv.org/3.4/d7/d1d/tutorial_hull.html) - cv::convexHull

[Creating Bounding boxes and circles for contours](https://docs.opencv.org/3.4/da/d0c/tutorial_bounding_rects_circles.html) - cv::boundingRect, cv::minEnclosingCircle

[Creating Bounding rotated boxes and ellipses for contours](https://docs.opencv.org/3.4/de/d62/tutorial_bounding_rotated_ellipses.html) - cv::minAreaRect, cv::fitEllipse

[Image Moments](https://docs.opencv.org/3.4/d0/d49/tutorial_moments.html) - cv::moments, cv::contourArea, cv::arcLength

[Point Polygon Test](https://docs.opencv.org/3.4/dc/d48/tutorial_point_polygon_test.html) - cv::pointPolygonTest

### Plan:
- Merge [Contours : Getting Started](https://docs.opencv.org/3.4/d4/d73/tutorial_py_contours_begin.html) and [Finding contours in your image](https://docs.opencv.org/3.4/df/d0d/tutorial_find_contours.html), using the simpler code from the former
-

## Ways We Can Contribute
| Category | Notes |
| -------- | -------- |
| Tutorials Editing | Grammar, spelling, punctuation, etc. |
| Tutorials Links | Citations, links to other tutorials or snippets |
| Tutorials Code Creation | Create tutorials with coding examples |
| Tutorials Code Python 3 Compatibility | Confirm all code snippets are compatible with Python 3.|
| Tutorials Code Consolidation | Ensuring all tutorials have code in Python and Java - may be as simple as copying over code from respective language section. Also identify where code snippets have been incorrectly located in the wrong directory. |
| Tutorials Accurate for OpenCV 4 | Checking that tutorials respect/note compatibility with version 4. |
| Coding Issues | Fix code where possible. |
| Install Guides | Check/update install guides. |
| Closing Pull Requests | Help review new feature/code submissions |
| Code Samples | Review/improve code samples [here](https://github.com/opencv/opencv/tree/master/samples/) |
| OpenCV Contrib | There is the [module](https://github.com/opencv/opencv_contrib) for OpenCV's extra contributions - which also have documentation and tutorials. |

## Miscellaneous
* Interesting but out of course scope: [Submit an article to OpenCV blog about contributing?](https://opencv.org/opencv-is-looking-for-blog-authors/)

#### About page revisions:
- 2500 vs 500 algorithms
- Fix the line start with these one issues

## Document Notes:
### [About Page (Contribute)](https://opencv.org/about/#Contribute)
- Nothing of note except for minor problems with the page itself.

### [How_to_contribute](https://github.com/opencv/opencv/wiki/How_to_contribute)
- From [Pro Git](https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks): "Like many other Version Control Systems, Git has a way to fire off custom scripts when certain important actions occur. There are two groups of these hooks: client-side and server-side. Client-side hooks are triggered by operations such as committing and merging, while server-side hooks run on network operations such as receiving pushed commits. You can use these hooks for all sorts of reasons."
- The hook referred to in bullet 5 under [Instructions](https://github.com/opencv/opencv/wiki/How_to_contribute#the-instruction-in-brief) is presumably a script that helps avoid whitespace problems.
- Otherwise a pretty standard workflow.

### [Writing documentation for OpenCV](https://docs.opencv.org/master/d4/db1/tutorial_documentation.html)
- For setup purposes, most likely want to refer to the Mac installation guide [here](https://docs.opencv.org/master/d0/db2/tutorial_macos_install.html).
- This document describes how documentation is generated from header files, the usage of other standalone pages (as with tutorials), and the repository documentation scheme.
- Links to the Doxygen [markdown support](http://www.doxygen.nl/manual/markdown.html) page for full reference on Doxygen markdown support.
- Full Doxygen [command reference](http://www.doxygen.nl/manual/commands.html).
- In pages you can place an `anchor`, which can then be refered to via a `ref`.
- Can include text as code in documentation with `code` and `endcode` tags. Code will be highlighted in accordance with file type (ex: .cpp) or can be directly specified.
- Can use `include` commands to include whole files. Should use `snippet` - must be marked in source files -for limited parts of files.
- Can used `toggle` to create toggle buttons for the different language snippets
- This document has a checklist for documentation creation.
- This document also lays out how to create a tutorial - all of the preferred ingredients and simplicity.

<br> <br> <br> <br> <br> <br>
<br> <br> <br> <br> <br> <br>
<br> <br> <br> <br> <br> <br>
## ALTERNATE PROJECTS:

### Pandas
Moving from wiki: https://github.com/pandas-dev/pandas/issues/30232
Capitalization in Docs:https://github.com/pandas-dev/pandas/issues/32550
Code Restructure: https://github.com/pandas-dev/pandas/issues/33478
milestone:https://github.com/pandas-dev/pandas/milestone/32
Undocumented Behavior: https://github.com/pandas-dev/pandas/issues/33778

### [Python-DS](https://github.com/prabhupant/python-ds)

### Scikit-Learn

### [Numpy](https://github.com/numpy/numpy)

### [Matplotlib](https://github.com/matplotlib/matplotlib)

# Ex-Project: [Atom](https://github.com/atom/atom)

## Current Issues / Pull Requests:
- Waiting on Response
- [atom/flight-manual.atom.io #608](https://github.com/atom/flight-manual.atom.io/issues/608)
- Merged
- [atom/github #2424](https://github.com/atom/github/pull/2424)

## Atom Organization Repos of Interest:
- [flight-manual.atom.io](https://github.com/atom/flight-manual.atom.io)

## Issues Tracker:
- [Beginner Issues](https://github.com/search?utf8=✓&q=is%3Aopen+is%3Aissue+label%3Abeginner+label%3Ahelp-wanted+user%3Aatom+sort%3Acomments-desc) **Note: These are OLD issues**
- [Help Wanted Issues](https://github.com/search?q=is%3Aopen+is%3Aissue+label%3Ahelp-wanted+user%3Aatom+sort%3Acomments-desc+-label%3Abeginner)
- See Flight Manual issues
- Language issues: [here](https://github.com/atom/language-python/issues/306) and [here](https://github.com/atom/language-ruby/issues/249#issuecomment-486420325)
- [New Java Language Support](https://github.com/atom/language-java/issues/223)
- [hover keyword css](https://github.com/atom/language-css/issues/128)
- Atom Core
- [Error scroll-to feature](https://github.com/atom/atom/issues/20584)
- [Variable Find Feature](https://github.com/atom/atom/issues/20583)
- [Get Commands Registered by a Package](https://github.com/atom/atom/issues/20525)
- [gitignore lines being ignored](https://github.com/atom/fuzzy-finder/issues/65)
- [Blank Line between commit n message](https://github.com/atom/github/issues/791)
- [Man page for apm](https://github.com/atom/apm/issues/427)

-----
## Next Steps
- Continue researching flight manual issues:
- Package: Active Editor Info images
- Section "[Package: Active Editor Info](https://flight-manual.atom.io/hacking-atom/sections/package-active-editor-info/)" would very much benefit from some images... Something like [this article](https://blog.atom.io/2017/05/23/docks-deep-dive.html) would be helpful. (Similar to [issue 602](https://github.com/atom/flight-manual.atom.io/issues/602)).
- Handling URIs
- More explanation of URIs "triggered from the system" in "[Handling URIs](https://flight-manual.atom.io/hacking-atom/sections/handling-uris/)" section would be nice...See [this link](https://discuss.atom.io/t/register-as-default-atom-uri-handler/50982/4) it is VERY helpful.
- Check out [Issue #6](https://github.com/atom/flight-manual.atom.io/issues/6)
- [Issue #48](https://github.com/atom/flight-manual.atom.io/issues/48) on Troubleshooting seems to have been covered with the flight manual [debugging](https://flight-manual.atom.io/hacking-atom/sections/debugging/) page. Remove from issues to tackle list?
- Search for beginner bugs/features/code fixes to tackle

## Flight Manual Problems to Tackle:
- "[Creating a Grammar](https://flight-manual.atom.io/hacking-atom/sections/creating-a-grammar/)" section states that syntax highlighting and folding support for many languages is still dependent on TextMate grammars, instead of the newer Tree-sitter parsers. a) Is this still true? b) perhaps this points to another opportunity for contribution?
- "[Creating a Legacy TextMate Grammar](https://flight-manual.atom.io/hacking-atom/sections/creating-a-legacy-textmate-grammar/)" section indicates that it is still a work in progress. a) Is this still true? b) Can we contribute?

Non-Problems/Archived:

- In the "[Writing specs](https://flight-manual.atom.io/hacking-atom/sections/writing-specs/)" section a link is provided for Jasmine which appears to be out of date - this is on purpose for compatibility reasons.

## Resources:

### Atom Docs
- [Atom Contributing Guide](https://github.com/atom/atom/blob/master/CONTRIBUTING.md)
- [Atom Flight Manual](https://flight-manual.atom.io)
- [Hacking on Atom Core](https://flight-manual.atom.io/hacking-atom/sections/hacking-on-atom-core/)
- [Contributing to Official Atom Packages](https://flight-manual.atom.io/hacking-atom/sections/contributing-to-official-atom-packages/)
- [Glossary](https://flight-manual.atom.io/resources/sections/glossary/)

### Language/Library Docs
- [CoffeeScript Documentation](http://coffeescript.org)
- [Less Documentation](http://lesscss.org)
- [Jasmine Documentation](https://jasmine.github.io/1.3/introduction.html)

### Styling & Best Practices
- [JavaScript Standard Style](https://standardjs.com)

## Development Notes:
- Atom consists of over 200 repositories. "Nearly every non-editor UI element you interact with comes from a package, even fundamental things like tabs and the status-bar. These packages are packages in the same way that packages in the Atom package repository are packages, with one difference: they are bundled into the default distribution."
- The contributing guide has a list of all of the key packages in the default distribution.
- There are a lot of style guidelines, so we definitely should work together to ensure we produce code and documentation that adheres to their guidelines - this compliance checking alone could be one of our jobs.
- There is a table dedicated to popular tags and easy links for searching for them in the core Atom repository and the Atom organization repositories at the bottom of the contribution guide.

## Install Problems:

- Python 2.7 is listed in [requirements](https://flight-manual.atom.io/hacking-atom/sections/hacking-on-atom-core/#requirements) but is a deprecated version, might be an issue??
- There is clearly an issue with setting up a development version of Atom with a version of Node newer than 10. Even that installation results in a multitude of warnings.

# Flight Manual Notes:
## Chapter 1 - Getting Started
### Why Atom?
- Atom is designed to be welcoming but also highly hackable / extensible.
- Wanted to base Atom on web technology but needed to escape the limitations put on web browsers - namely restrictions on local system resources, such as files or subprocesses. Therefore - *"For this reason, we didn't build Atom as a traditional web application. Instead, Atom is a specialized variant of Chromium designed to be a text editor rather than a web browser. Every Atom window is essentially a locally-rendered web page."*
- Node makes everything modular - breaks down all requirements into small packages.
- Running on newest version of Chromium, uses Flexbox. They have added APIs at the meeting point between JS and C++.
- Part of a larger vision: *"We see Atom as a perfect complement to GitHub's primary mission of building better software by working together. Atom is a long-term investment, and GitHub will continue to support its development with a dedicated team going forward. But we also know that we can't achieve our vision for Atom alone. As Emacs and Vim have demonstrated over the past three decades, if you want to build a thriving, long-lasting community around a text editor, it has to be open source."*

### Installing Atom
- Configuration and state stored in the .atom directory generally in home folder. Can use Atom in "portable mode" where the app and the configuration can be stored on a removable storage device.

### Atom Basics
- Cmd+Shift+P - brings up the command palette, where you can search through all commands.
- Tree View (file viewer) is not built into the editor but is a standalone package shipped with the default distribution - one of the **"Core Packages"**.
- **Core Package**: A package bundled with the default distribution.
- **Community Package**: Packages not bundled with the default distribution.
- Their shorthand for describing settings it packagename.SettingInCamelCase.

## Chapter 2 - Using Atom
### Atom Packages
- More than 80 packages make up the default distribution - Welcome Screen, spellchecker, themes, fuzzy finder, etc.
- Packages and themes can be installed from the command line with Atom Package Manager - **apm**. Can be used to search for packages and information, install packages in specific versions, etc.

### Moving in Atom
- keymap.cson holds bindings (key mappings) for various commands and can be easily expanded.
- Bookmarks package adds the ability to "bookmark" significant lines of code.

### Atom Selections
- Just discusses text selection commands

### Editing and Deleting Text
- whitespace package deals with whitespace commands.
- bracket matcher is a package which deals with ensuring brackets are closed
- encoding selector is the package that deals with text encodings - like UTF-8

### Find and Replace
- find and replace is its own package - does exactly what it sounds like

### Snippets
- language-html is its own package - supports html syntax highlighting and grammar, plus adds a number of "snippets" where, for example, you can type "html" press tab and have template code expanded for you.
- snippets.cson contains all the custom snippets you create.

### Autocomplete
- autocomplete-plus package implements text autocompletion.

### Folding
- Folding refers to hiding blocks of code for easy review.

### Panes
- Covers ability to have multiple panes - and tabs package which allows easy switching between them.

### Pending Pane Items
- Pending Pane Items are essentially temporary file previews.

### Grammar
- grammar-selector package is responsible for attempting to determine the language used in the opened file - looking at the file type and the content.

### Version Control in Atom:
- Atom ships with built in git support
- git-diff package responsible for colorizing the "gutter" to reflect additions, deletions, etc.

### Github Package
- Provides Github integration support - allowing for easy use of Github information (such as usernames) and actions, such as making a pull request.

### Writing in Atom
- Can also use Atom for everyday writing - built in spell-checking for plain text and some markdown.
- markdown-preview package allows for previewing markdown in a side pane.

### Basic Customization
- Atom uses CSON (Coffee Script Object Notation) files for configuration (excluding init script and style sheet).
- Will see .less files - Less is a CSS preprocessor that makes CSS easier.

## Chapter 3 - Hacking Atom
### Tools of the Trade
- Atom primarily implemented in JavaScript and CSS - using Less CSS preprocessor. Much of Atom has been converted from the previously used CoffeeScript but not done where this could be dangerous - still depends on CSON.
- "Just about everything you can do with CoffeeScript in Atom is also doable in JavaScript."
- Less adds things like variables and functions to CSS

### The Init File
- When Atom finishes loading it evaluates the init.coffee file in your ~/.atom directory - can add customizations here - code here has full access to Atom API.

### Package: Word Count
- Atom has a built in package generator, which itself is a package: *package-generator*.
- It creates a package directory which is loaded into ~/.atom/packages
- The basic package structure (which is auto-generated) is as follows:

my-package/
├─ grammars/
├─ keymaps/
├─ lib/
├─ menus/
├─ spec/
├─ snippets/
├─ styles/
├─ index.js
└─ package.json

- Not every folder will be needed for every package.
- The top-level directory contains a package.json file containing metadata, path to main module, dependencies, resource loading order, package activation conditions, etc.
- A package should contain a single top-level module - specified as the main module - which handles all interaction with Atom. Other (implementation) code should be included in lib and required by the main module.
- There are some key methods which *can* be used here defining the startup and exit behaviors of your package.
- Can add own styles (preferably building off existing ui style), key mappings, menus, application menus, context menu.
- Because Atom is built on Chromium, can use the same developer tools panel as you would in Chromium. Command: Alt + Cmd + I
- Package tests should be placed in the spec directory.

### Package: Modifying Text
- Just contains another nice package example.

### Package: Active Editor Info
- A package can show information in a "modal panel" as in the examples in the previous two examples but can also display information in a workspace item - done by registering an *opener* with Atom - an opener accepts a URI (Uniform Resource Identifier) and, if URI is known, returns a view.

### Creating a Theme
- Less is a superset of CSS.
- Changes in the source code - such as changing a color in Less - will be instantly reflected in Atom if run in dev mode.

### Creating a Grammar
- Atom's syntax highlighting and code folding support is based on a system which creates trees for understanding code structure - Tree-sitter. The Tree-sitter grammars are still new however and many languages still depend on the older TextMate grammars.

### Creating a Legacy TextMate Grammar
- Nothing of note here aside from it being a work in progress.

### Publishing
- Explains the usage of apm for publishing a package.

### Iconography
- Discusses uses of icons in Atom

### Debugging
- Explains process of debugging issues with Atom.
- Can start Atom in safe mode, which will not launch installed packages or refer to the init script.
- Can take the dangerous action of clearing the window state or restoring to factory defaults.

### Writing Specs
- Atom uses Jasmine - a development framework for writing tests for JavaScript - as its spec framework.

### Handling URIs
- Packages can register to handle URIs triggered by the system.

### Cross-Platform Compatibility
- Talks about ensuring cross-platform compatibility in developing your own packages - ex: supported characters, searching, etc.

### Converting from TextMate
- Discusses converting TextMate themes/grammars to Atom.

### Hacking on Atom Core
-