Permalink
Browse files

Merge pull request #79 from MrIlliteracy/master

Readme change
  • Loading branch information...
illy
illy committed Dec 15, 2017
2 parents f3b0f78 + 22fba59 commit 779899e54b3d91c2a8c073aa5e8f840a2b1b7c96
Showing with 28 additions and 10 deletions.
  1. +28 −10 README.md
View
@@ -11,13 +11,12 @@
**Note:**
> CemUI v2.0 is currently a WIP and is not guaranteed to be stable.
# Credits
| Icon | Name | Credit | Twitter | GitHub |
|---------------------------------------------------------|-----------------------------|----------------------------------------------------------------------------------|------------------------------------|----------------------------------|
| <img src="https://i.imgur.com/5QshX3v.png" height="32"> | RedDucks(s)/Jonathan Barrow | Founder/lead developer. Handles all backend functionality and maintains the API. | [Redducks Twitter](https://twitter.com/jondbarrow) | [Redducks GitHub](https://github.com/RedDuckss) |
| <img src="https://i.imgur.com/OFFt3eK.png" height="32"> | MrJVS | 2.0 co-founder. Handles all frontend functionality and presentation. | [MrJVS GitHub Twitter](https://twitter.com/TWmrjvs) | [MrJVS GitHub](https://github.com/mrjvs) |
| <img src="https://i.imgur.com/Rc3lGbO.png" height="32"> | Somebody2804(BenTheHuman) | UI/Frontend designer. | | |
| | dragnu5(Dragnus) | Creator of over 400 custom images for CemUI. | | |
# Screenshots
## Themes
![Themes](https://i.imgur.com/Oso0kmy.gif)
## Super Mario Maker Integration
![SMM Integration](https://i.imgur.com/WEswjZV.gif)
# Changelog & FAQ
### [Changelog](https://github.com/RedDuckss/CemUI/blob/master/CHANGELOG.md)
@@ -29,13 +28,15 @@
We **always** welcome suggestions and Pull Requests! This program is written in NodeJS and packaged with Electron. This means that anyone with experience in JavaScript, Node, HTML, CSS, and C++ can contribute just fine! With Node, C++ users can contribute as well, due to Node supporting C++ modules!
![Fork](https://img.shields.io/github/forks/RedDuckss/CemUI.svg?style=social&label=Fork)
**If you have a suggestion, and do not know any of the required languages, you can reach us on our [Discord server][1]**
**If you have a suggestion, and do not know any of the required languages, you can reach us on [Discord][1]**
# How to get the latest version of CemUI
The latest official builds can be found in the [GitHub Releases section](https://github.com/RedDuckss/CemUI/releases).
The latest official builds can be found in the [GitHub Releases section](https://github.com/RedDuckss/CemUI/releases). These are stable builds.
To get the latest developer version of CemUI right now, you may build and run from source. These are more likely to be unstable.
To get the latest developer version of CemUI right now, you may run from source. To do this, follow these steps:
To get the latest developer version, follow these steps:
1. Install [NodeJS](https://nodejs.org/)
2. Clone/Download this repo
@@ -61,6 +62,7 @@ CemUI supports loading 3rd party themes. Themes can be loaded from `%appdata%/Ce
# Events
To fully utilize themes you will need to hook into the many events emitted (not all possible events are documented)
[See the Events section of the wiki for documentation](https://github.com/RedDuckss/CemUI/wiki/Events)
# I found a bug!
Given that this project is still very early in development, bugs will probably be common, and vary from person to person. If you find a bug, we ask that you follow this format for reporting the bug on the [Issue Tracker](https://github.com/RedDuckss/CemUI/issues) on the repo:
- A detailed name describing the bug (no "A bug happened" type titles!)
@@ -72,4 +74,20 @@ Given that this project is still very early in development, bugs will probably b
- If possible, a video or gif showing the exact steps to reproduce (There are many free video recorders out there. It doesn't matter how you record it, as long as it's recorded)
- And above all: stay calm. Currently there are only 2 developers working on this project, and for one this is the first NodeJS app they have worked on. Also given the nature of how Electron packages apps, bugs may not occur on our end but will on yours. Please be patient while we attempt to fix the issue.
## Good bug report
![Good report](https://i.imgur.com/zjjLpn4.png)
## Bad bug report
![Bad report](https://i.imgur.com/9qM0lGy.png)
Found a bug? [Create an issue here!](https://github.com/RedDuckss/CemUI/issues/new)
# Credits
| Icon | Name | Credit | Twitter | GitHub |
|---------------------------------------------------------|-----------------------------|----------------------------------------------------------------------------------|------------------------------------|----------------------------------|
| <img src="https://i.imgur.com/5QshX3v.png" height="32"> | RedDucks(s)/Jonathan Barrow | Founder/lead developer. Handles all backend functionality and maintains the API. | [Redducks Twitter](https://twitter.com/jondbarrow) | [Redducks GitHub](https://github.com/RedDuckss) |
| <img src="https://i.imgur.com/OFFt3eK.png" height="32"> | MrJVS | 2.0 co-founder. Handles all frontend functionality and presentation. | [MrJVS GitHub Twitter](https://twitter.com/TWmrjvs) | [MrJVS GitHub](https://github.com/mrjvs) |
| <img src="https://i.imgur.com/Rc3lGbO.png" height="32"> | Somebody2804(BenTheHuman) | UI/Frontend designer. | | |
| | dragnu5(Dragnus) | Creator of over 400 custom images for CemUI. | | |
[1]: https://discord.gg/EKn8HnW

0 comments on commit 779899e

Please sign in to comment.