Merge pull request #1 from mcdonnelldean/0.0.1

0.0.1 to master

CONTRIBUTING.md

@@ -0,0 +1,84 @@
+# Contributing
+Focus White is an __open project__ and encourages participation regardless or race, gender, or
+sexual orientation. If you feel you can help in any way please be our guest.
+
+
+Contributing is not always about adding new features, there are plenty of other ways to get
+involved, for instance:
+
+- add more languages
+- optimize styling performance.
+- report, find and/or fix bugs.
+
+Like any other project there is plenty to be done for people of all skill levels and specialities,
+if you have any questions, simply open an issue in the project's [Issues Section][] on GitHub.
+
+## Obtaining the Source
+In order to obtain the source for Focus White we first suggest you fork it on Github. After this is
+done, navigate to a suitable directory on your machine and run:
+
+```
+git clone https://github.com/<USERNAME>/atom-focus-white.git
+```
+
+This will pull your fork into a new folder `/atom-focus-white`, move to this directory using:
+
+```
+cd atom-focus-white
+```
+
+You now have access to your own local copy of Focus White to do as you please with.
+
+## Making a Contribution
+If you have something you would like to contribute first ensure your master branch is up to date
+with ours, we assume a remote named mcdonnelldean exists that points to the master repo.
+
+```
+git checkout master
+git pull --rebase mcdonnelldean master
+```
+
+Next, create a branch for your contribution:
+
+```
+git checkout -b name-of-my-branch
+```
+
+Go ahead and work on your feature creating commit's as needed. To create a commit at the command
+line simply do:
+
+```
+git add --all
+git commit -m "a commit message"
+```
+
+If you need to create multiline commit messages simply press enter before adding the second `"`
+this will cause the console to add a line break to the commit and put the curser on a new line,
+to finish simply close the string and press enter.
+
+## Creating a Pull Request
+Commit your changes until you are happy. Once you are ready to submit a pull request jump back
+out to master and rebase again to ensure you have the latest source:
+
+```
+git checkout master
+git pull --rebase mcdonnelldean master
+git push -f origin master
+```
+
+Next jump back on to your branch and rebase it with your newly updated master:
+
+```
+git checkout name-of-my-branch
+git rebase master
+git push -f origin name-of-my-branch
+```
+
+Finally navigate to your fork on github. You should see a small marker to create a pull
+request, just above the repo explorer. Make sure you add some information along with your
+pull request, it makes reviewing it easier.
+
+## License
+Licensed under [MIT](./LICENSE) 2015 Dean McDonnell
+
+[Issues Section]: https://github.com/mcdonnelldean/atom-focus-white/issues

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015 Dean McDonnell (mcdonnelldean)
+Copyright (c) 2015 Dean McDonnell
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,10 +1,80 @@
 # Focus White
-An [Atom](http://atom.io) Syntax Theme
+[![use-with][use-with-badge]][use-with-url]
+[![git][git-badge]][git-url]
+[![apm][apm-badge]][apm-url]
+[![nearform][nearform-badge]][nearform-url]
+
+Focus White is a hyper minimal syntax theme for [Atom.io][] which removes superfluous highlighting in
+favor of more focused highlighting that helps draw the eye to read instead of just acknowledging keywords by
+color.
 
 ## How To Install
-For now, clone the repo and apm link to symlink into your atom folder. Package comming soon.
+It is recommended that packages are installed via APM or Atom's package management interface. Packages should
+only be installed manually when you want to modify, debug, or otherwise change the package itself. Manually
+installed packages will not take advantage of Atom's updater mechanism.
+
+### Via Atom's preferences pane
+
+1. Open atom's preferences pane
+2. On the sidebar, choose install
+3. Toggle the _search packages_ search bar to Themes
+3. In the _search themes_ box, search for _focus white_
+4. Choose the correct package, the author will be _mcdonnelldean_
+5. Hit install on the the found package
+6. Select Themes from the sidebar
+7. In the themes dropdown select Focus White
+8. Restart any instances of Atom.io
+
+### Using APM
+
+1. Open the command line
+2. Run `apm install focus-white`
+3. Open atom's preferences pane
+4. Select Themes from the sidebar
+5. In the themes dropdown select Focus White
+6. Restart any instances of Atom.io
+
+### Manually
+
+1. Fork this repository
+2. Pull down your fork via github
+3. Open the terminal in the package's root directory
+4. Run `apm link`, which will symlink the package to Atom
+5. Open atom's preferences pane
+6. Select Themes from the sidebar
+7. In the themes dropdown select Focus White
+8. Restart any instances of Atom.io
+
+## Supported Languages
+Language support is on a per needed basis. If you need a particular language to be supported, create an
+issues with some sample code to use and I will include support for it with the next feature update.
+
+### Javascript
+
+![js-sample][]
+
+Note that this theme styles the full editor pane, that means the whole pane, including gutters and
+gutter symbols will be overridden for styling. This is in line with Atom's best practices for Syntax vs
+UI theming.
+
+## Contributing
+Focus White is an __open project__ and encourages participation regardless or race, gender, or sexual
+orientation. If you feel you can help in any way please be our guest. See our [Contributing Guide][] for
+information on how to pull this repository as well as how to create a pull request to send to us.
 
 ## License
 Licensed under [MIT](./LICENSE) 2015 Dean McDonnell
 
-_Sponsored by [nearForm](http://nearform.com), who encourage me to open source all the things!_
+[use-with-badge]: https://img.shields.io/badge/use%20with%20-atom.io-green.svg?style=flat-square
+[use-with-url]: https://atom.io
+[git-badge]: https://img.shields.io/github/release/mcdonnelldean/atom-focus-white.svg?style=flat-square
+[git-url]: https://github.com/mcdonnelldean/atom-focus-white/releases
+[apm-badge]: https://img.shields.io/apm/v/atom-focus-white.svg?style=flat-square
+[apm-url]: https://atom.io/packages/atom-focus-white
+[nearform-badge]: https://img.shields.io/badge/sponsored%20by-nearForm-red.svg?style=flat-square
+[nearform-url]: http://nearform.com
+
+[Atom.io]: https://atom.io/
+[Contributing Guide]: ./CONTRIBUTING.md
+
+[js-sample]: ./images/js-sample.png

index.less

@@ -1,9 +1,9 @@
 // Atom internal stuff
-@import 'syntax-variables';
 @import 'colors';
-
+@import 'syntax-variables';
 @import 'editor-styles';
 
 // per-lang styles
 @import 'javascript-styles';
 @import 'css-styles';
+@import 'markdown-styles';

package.json

@@ -1,8 +1,8 @@
 {
   "name": "focus-white",
   "theme": "syntax",
-  "version": "0.1",
-  "description": "A light syntax theme",
+  "version": "0.0.1",
+  "description": "A black text on white background theme for Atom.io, with hyper minimal coloring.",
   "repository": "https://github.com/mcdonnelldean/atom-focus-white",
   "license": "MIT",
   "engines": {

styles/css-styles.less

@@ -1,14 +1,27 @@
 .css {
+  color: black;
+
+  .html,
+  .import,
   .attribute-name {
-      font-weight: bold;
+    font-weight: bold;
+    color: black;
   }
 
   .comment {
     color: @green;
     font-style: italic;
   }
 
+  .string,
   .constant {
     color: @red;
   }
+
+  .property-value {
+    .variable,
+    .constant {
+      color: @red;
+    }
+  }
 }

styles/javascript-styles.less

@@ -1,6 +1,8 @@
 // Javascript Styles
 
 .js {
+  color: @black;
+
   .keyword,
   .storage.function,
   .variable.language,

styles/markdown-styles.less

@@ -1,5 +1,22 @@
-.gfm.markup {
-  .heading.marker {
+.gfm {
+  color: @black;
+
+  .marker,
+  .bold {
+    font-weight: bold;
+  }
+
+  .italic {
+    font-style: italic;
+  }
+
+  .raw {
+    color: @red;
+  }
+
+  .punctuation,
+  .entity,
+  .link {
     color: @green;
   }
 }

styles/syntax-variables.less

@@ -1,5 +1,5 @@
 // General colors
-@syntax-text-color: #555;
+@syntax-text-color: black;
 @syntax-cursor-color: 555;
 @syntax-selection-color: #afc4da;
 @syntax-selection-flash-color: #69c;
@@ -17,8 +17,8 @@
 // Gutter colors
 @syntax-gutter-text-color: @syntax-text-color;
 @syntax-gutter-text-color-selected: @syntax-gutter-text-color;
-@syntax-gutter-background-color: white;
-@syntax-gutter-background-color-selected: rgba(255, 255, 134, 0.34);
+@syntax-gutter-background-color: @syntax-background-color;
+@syntax-gutter-background-color-selected: @syntax-background-color;
 
 // For git diff info. i.e. in the gutter
 @syntax-color-renamed: #96CBFE;