浏览代码

Updated readme files

flabbet 5 年之前
父节点
当前提交
a4b2e50050
共有 4 个文件被更改,包括 55 次插入74 次删除
  1. 0 46
      CODE_OF_CONDUCT.md
  2. 4 6
      CONTRIBUTING.md
  3. 2 2
      PULL_REQUEST_TEMPLATE.md
  4. 49 20
      README.md

+ 0 - 46
CODE_OF_CONDUCT.md

@@ -1,46 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
-
-## Our Standards
-
-Examples of behavior that contributes to creating a positive environment include:
-
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
-
-Examples of unacceptable behavior by participants include:
-
-* The use of sexualized language or imagery and unwelcome sexual attention or advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a professional setting
-
-## Our Responsibilities
-
-Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
-
-Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
-
-## Scope
-
-This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [email protected]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
-
-Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
-
-[homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/4/

+ 4 - 6
CONTRIBUTING.md

@@ -5,19 +5,17 @@ Hey! Thanks for being interested in project! It means a lot. But, before contrib
 When contributing to this repository, please first discuss the change you wish to make via issue,
 email, or any other method with the owners of this repository before making a change. 
 
-Please note we have a [code of conduct](https://github.com/flabbet/PixiEditor/blob/master/CODE_OF_CONDUCT.md), please follow it in all your interactions with the project.
-
 ## Issues
 
 If you want to report a bug, follow steps below, if you want to request a feature, check [this](https://github.com/flabbet/PixiEditor/blob/master/.github/ISSUE_TEMPLATE/feature_request.md)
 
-* First of all, check if the issue is on the [list](https://github.com/flabbet/PixiEditor/issues) and/or [board](https://github.com/flabbet/PixiEditor/projects/1), if yes, upvote it.
+* First of all, check if the issue is on the [list](https://github.com/flabbet/PixiEditor/issues) and/or [board](https://github.com/flabbet/PixiEditor/projects), if yes, upvote it.
 
 * If not, report an issue [here](https://github.com/flabbet/PixiEditor/issues) like that:
  1. Clear as short as possible title
  2. Describe issue as detailed as possible
- 3. Include screenshots, error logs, etc.
- 
+ 3. Include screenshots if possible.
+
  ## Pull Requests
- 
+
  Before pull request, read [this](https://github.com/flabbet/PixiEditor/blob/master/PULL_REQUEST_TEMPLATE.md)

+ 2 - 2
PULL_REQUEST_TEMPLATE.md

@@ -1,7 +1,7 @@
  ## Pull Requests
- 
+
  Pull request rules:
- 
+
  1. Clearly describe changes, as detailed as possible
  2. If possible, show examples of usage
  3. Ensure any install or build dependencies are removed before the end of the layer when doing a build.

+ 49 - 20
README.md

@@ -1,41 +1,70 @@
-[![Build Status](https://dev.azure.com/flabbet/PixiEditor/_apis/build/status/flabbet.PixiEditor?branchName=master)](https://dev.azure.com/flabbet/PixiEditor/_build/latest?definitionId=3&branchName=master)
+[![Build Status](https://img.shields.io/azure-devops/build/flabbet/PixiEditor/3)](https://dev.azure.com/flabbet/PixiEditor/_build/latest?definitionId=3&branchName=master) [![Code coverage](https://img.shields.io/azure-devops/coverage/flabbet/PixiEditor/3)](https://codecov.io/gh/flabbet/PixiEditor)[![Release](https://img.shields.io/github/v/release/flabbet/PixiEditor)](https://github.com/flabbet/PixiEditor/releases) [![Discord Server](https://badgen.net/badge/discord/join%20chat/7289DA?icon=discord)](https://discord.gg/qSRMYmq) ![contributions](https://img.shields.io/badge/contributions-open-brightgreen)
 
 # PixiEditor
-PixiEditor is lightweighted pixel art creator.
 
-![screenshot](https://raw.githubusercontent.com/flabbet/PixiEditor/master/Screenshot.png)
+A Pixel art editing software. Create beautiful sprites for your games, animations (coming soon!) and edit images. All packed in eye-friendly dark theme.
 
-## Getting started with PixiEditor
+## About PixiEditor
 
-Follow these instructions to get PixiEditor working on your machine.
+Want to create beautiful pixel arts for your games? PixiEditor can help you! Our goal is to create fully open-source, fast and feature rich pixel art creator. 
 
-### Software Requirements
+### Familiar interface
+
+Have you ever used Photoshop or Gimp? Reinventing the wheel is unnecessary, we wanted experienced users to get familiar with the tool quickly and without a ease new users
+
+![](C:\Users\flubb\OneDrive\Documents\ShareX\Screenshots\2020-07\PixiEditor_0.1.png)
+
+
+
+### Light weighted
 
-```
-.NET Core 3.0
-```
+I takes only 157 MB to install PixiEditor.
 
-### Installing
+### Active development
 
-1. Download .zip file from [here](https://github.com/flabbet/PixiEditor/releases)
+PixiEditor started in 2018 and it's been actively developed since. We continuously improve code quality to ensure the best experience and performance.
 
-2. Open installer 
 
+
+## Installation
+
+Follow these instructions to get PixiEditor working on your machine.
+
+1. Download .exe file from [here](https://github.com/flabbet/PixiEditor/releases)
+2. Open installer
 3. Follow installer instructions
 
-## Built with
 
-* [Extended WPF Toolkit](https://github.com/xceedsoftware/wpftoolkit) - More controls and themes for WPF
-* [WriteableBitmapEx](https://github.com/teichgraf/WriteableBitmapEx/) - Collection of extension methods for the XAML WriteableBitmap
+
+## Support
+
+Struggling with something? You can find support in a few places:
+
+* Check out [documentation](https://github.com/flabbet/PixiEditor/wiki)
+
+* Ask on [Discord](https://discord.gg/XKbUBhj)
+* Open new [Issue](https://github.com/flabbet/PixiEditor/issues)
+
+
+
+## Building from source
+
+### Software Requirements
+
+* .NET Core 3.1
+
+* Visual Studio
+
+  ### Instructions
+
+  1. Clone Repository
+  2. Open PixiEditor/PixiEditor/PixiEditor.sln in Visual Studio
+  3. Build solution
 
 ## Contributing 
 
 Please read [CONTRIBUTING.md](https://github.com/flabbet/PixiEditor/blob/master/CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
 
-## Authors
-* **Krzysztof Krysiński** *Creator of the project* - [flabbet](https://github.com/flabbet)
-* [Contributors](https://github.com/flabbet/PixiEditor/graphs/contributors)
-
 ## License
 
-This project is licensed under the MIT License - see the [LICENSE.md](https://github.com/flabbet/PixiEditor/blob/master/LICENSE) - file for details
+This project is licensed under the MIT License - see the [LICENSE.md](https://github.com/flabbet/PixiEditor/blob/master/LICENSE) - file for details