Skip to content

Latest commit

 

History

History
executable file
·
186 lines (116 loc) · 9.7 KB

README.md

File metadata and controls

executable file
·
186 lines (116 loc) · 9.7 KB

Seti UI

Gitter apm apm apm Gratipay Team

Seti-UI Theme, and VS Code icon pack

This repo contains the latest version of the Seti UI theme. It's a dark interface theme crafted especially for Atom, with subtle colors that are meant to be easy on the eyes. It includes custom file icons, and new user configurable settings. Seti Syntax is also available for all your codez.

The icons in this repo are used as the defaults in the file explorer in VS Code also.

Please Note: This is the Seti interface theme for Atom only

This is for the interface of the Atom editor. I also have Seti Syntax for theming the code view in Atom. In addition, there is a new Seti theme for Hyper.

If these are not the droids you're looking for, may I point you in the direction of these great ports:


What's New? 1.0 Update

Seti UI has been updated with a cleaner, more streamlined interface, a slightly tweaked color scheme, additional icons and new user settings, as well as a handful of other small ui improvements and a refactored code base.

Screenshot


More colors

Seti now has 8 theme colors to choose from: Screenshot


More icons

File icons will now show up in the file search (cmd+ p) dialog in addition to the side bar and tabs. This should make for easier grokking when you're searching for a file.

Screenshot


Settings

To get here, Go to "Atom > Preferences" Select "Themes" and click the settings icon next to "Seti" under UI Theme dropdown

With 1.0 you can now adjust some of the more commonly requested features directly in Atom's settings view (Settings > Themes > Click the gear icon next to Seti).

  • File Icons: Probably the most frequent request has been a simpler way to disable the file icons for those of you using other file icon packages. Now you can :)
  • Compact Mode : Seti 1.0's face-lift brings a cleaner, less cramped interface, which also happens to take up a bit more space. If you prefer the old more compact version, you can revert it here.
  • Ignored Files: By default, ignored files are shown as a muted grey. However, if you'd like to hide them altogether you can use this.
  • Hide Tabs: Lastly (for now), there have been a few requests to be able to hide tabs altogether. This is of course disabled by default, but if you're the anti-tab type, you can hide them here.

Screenshot

Setting are brand new, and still have a few kinks to be worked out. If you run into any problems with them, or would like to request an additional setting, please file an issue!


Bugs

If you find a bug, please do add a bug report. However, first make sure it is for Seti UI in Atom. I only support the Atom versions, please check the links above to report a bug on another platform.

Seti 1.0 has been optimized to work with Atom 1.6 and above:
Including the 1.7 beta

Most if not everything should work on older versions as well, but if you see something that doesn't look quite right, make sure you have the latest version of Atom installed before filling a bug.


Installation

The easiest way to install Seti is to do as follows:

  • Go to Atom > Settings
  • Click "+ Install"
  • Search for seti ui and click themes button to search.
  • Browse for Seti UI and click install

Alternatively you can use the Atom Package Manager:

apm install seti-ui

Contributing

Anyone is welcome to contribute to the development of this theme. If can be a lot of work to keep up on, and I'll take help wherever I can get it :)

1. Fork

If you're keen to contribute, start by forking the repo and cloning it to your computer.

Note: To use the development version, you must first uninstall the production version (apm uninstall seti-ui), then run the following commands:

# To install the local version as an Atom Theme
apm link .

# Open with dev mode:
atom --dev .

2. Make Some Changes

Once this is complete you will be able to edit seti files directly in Atom and see your changes in real time.

3. Create a Pull Request

Once you are satisfied, with your updates, commit your change, push them to your fork and submit a pull request with a description of the changes that you made.

4. Unlink

Once you're done working locally and ready to install the production version again, simply run apm unlink . from the root of the seti-ui project.


Adding File Icons

Given that changes to this repo are included in VS Code, we are somewhat conservative with adding new file icons because it can affect the performence for everyone. This means we only accept PRs for file icons for popular languages or toolsets. For example does your langauge/tool have package downloads or vscode extensions with thousands of users? If no, then there's a possibility we will deny your pull request.

Adding an icon requires you have node installed. Once you have it, you will need to open a terminal window, navigate to the seti-ui folder and run npm install (note you only need to do this once).

All of the icon's colors will be automatically converted to their closest equivalents on the supported color list. This process uses a very simple mathematical algorithm for determining what's "closest", and might not match what you subjectively feel to be appropriate. That's why if you don't like what the build script generates, choose the colors yourself.

Once everything is setup, follow these steps any time you want to add a new icon:

  1. Create an SVG icon with the name of the language, and save it to the src/icons folder (do not use any spaces or special characters)

  2. Open styles/components/icons/mapping.less and create a link for the icon you just added with the .icon-ext mixin. Assuming you were adding an icon for Sass it might look something like this: .icon-ext('.scss', 'sass', 'pink')

The first parameter '.scss' is the file extension you want to target, the second parameter 'sass' is the name of the icon you just created, without the extension (sass.svg), and the last parameter pink indicated what color the icon should be.

There are currently 9 supported icon colors:

- `blue`
- `grey`
- `green`
- `orange`
- `pink`
- `purple`
- `red`
- `white`
- `yellow`

While, you can add additional colors to styles/ui-variables.less, but please do not do this unless you find it absolutely necessary. If you do add another color, please make sure that matches the general feel of the other colors. If you add something really bright or really pale, your pull request will likely be declined.

You will need to do this once for every extension, you want to target. For example, if you want to target both .sass and .scss extensions, you would add the following:

.icon-set('.sass', 'sass', 'pink');
.icon-set('.scss', 'sass', 'pink');
  1. Run npm run build:svg to minimize the svg files.

Previewing in VS Code

This is a bit of work, but the steps:

  1. Make your changes, and run npm run build:svg
  2. Clone VS Code, and make sure that it has the same parent as seti-ui
  3. Follow the VS Code instructions to set up a local dev copy
  4. Once you've confirmed that, you need to update the icons, run npm run vs-theme

Then, you can make you SVG changes, re-run npm run build:svg, npm run vs-theme and re-launch your dev copy of VS Code.

Deploying

Run npm publish


Current Icons

Screenshot


Custom App Icons

If you'd like a new app icon to match the look & feel of Seti, feel free to use one of these:

Screenshot Screenshot Screenshot