mirror of
https://github.com/Toinane/colorpicker.git
synced 2026-08-28 10:05:11 -05:00
74 lines
2.5 KiB
Markdown
74 lines
2.5 KiB
Markdown
<p align="center">
|
|
<a href="https://colorpicker.fr">
|
|
<img src="config/release/icon_osx.png" width="256" height="256" alt="ColorPicker icon" />
|
|
</a>
|
|
<h1 align="center">Colorpicker</h1>
|
|
<p align="center">Modern and powerful color management software</p>
|
|
<p align="center">
|
|
<img src="https://badgen.net/github/release/toinane/colorpicker/stable" />
|
|
<img src="https://img.shields.io/github/downloads/toinane/colorpicker/total.svg">
|
|
<img src="https://img.shields.io/github/downloads/toinane/colorpicker/latest/total.svg">
|
|
<img src="https://img.shields.io/github/release-date/Toinane/colorpicker.svg">
|
|
<img src="https://github.com/Toinane/colorpicker/actions/workflows/dev.yaml/badge.svg">
|
|
<a href="https://snapcraft.io/colorpicker-app">
|
|
<img alt="colorpicker-app" src="https://snapcraft.io/colorpicker-app/badge.svg" />
|
|
</a>
|
|
<a href="https://crowdin.com/project/colorpicker">
|
|
<img src="https://badges.crowdin.net/colorpicker/localized.svg">
|
|
</a>
|
|
</p>
|
|
</p>
|
|
|
|
---
|
|
|
|
<h4 align="center">
|
|
Want to help with the localization of Colorpicker?
|
|
</h4>
|
|
<p align="center">
|
|
Please connect to <a href="https://crowdin.com/project/colorpicker" target="_blank">Crowdin and join the project</a>, your contribution is highly appreciated! 👍
|
|
</p>
|
|
|
|
---
|
|
|
|
## About Colorpicker
|
|
|
|
Colorpicker is a color management software. Grab any color on your computer screen, easily adjust it to your convenience and save it in personalized color categories.
|
|
|
|
Colorpicker is built on top of **Electron** with modern frameworks and works as well on **Windows**, **Macos** and **Linux**.
|
|
|
|
## Download
|
|
|
|
You can download [Colorpicker on the releases page](https://github.com/Toinane/colorpicker/releases).
|
|
|
|
## Development
|
|
|
|
#### How to contribute
|
|
|
|
Colorpicker use **Preact** to make front development easier with components. **Typescript** is also used to be more consistent and get less side effects.
|
|
|
|
You should use a Code Editor compatible with _Prettier_ and _ESLint_ plugins like **VS Code**.
|
|
|
|
- Install dependencies
|
|
|
|
```shell
|
|
npm i
|
|
```
|
|
|
|
- Launch Colorpicker in development mode
|
|
|
|
```shell
|
|
npm run dev
|
|
```
|
|
|
|
- Make a Nightly build
|
|
|
|
```
|
|
npm run release:nightly
|
|
```
|
|
|
|
#### How to make stable release
|
|
|
|
Colorpicker uses **Github Actions** to make a release automatically. This allows to have the application available on all platforms without having to do it manually.
|
|
|
|
A **Nightly** version is automatically created at each PR merge on `dev` branch and a **Stable** version is automatically created at each PR merge on `master` branch.
|