mirror
/
pixel-editor
mirror of https://github.com/lospec/pixel-editor.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Added codespace instructions

This commit is contained in:
Nicola 2023-02-13 18:11:40 +01:00 committed by GitHub
parent 510694305b
commit aeb8892dc0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -44,13 +44,18 @@ Suggestions / Planned features:
## How to Contribute
### Requirements
You must have node.js and git installed.
No requirements if you want to use Github's Codespaces. If you prefer to setup your environment on desktop, you'll need to have node.js and git installed.
You also need `npm` in version 7 (because of 2nd version of lockfile which was introduced there) which comes with Node.js 15 or newer. To simplify installation of proper versions you can make use of [nvm](https://github.com/nvm-sh/nvm#installing-and-updating) and run `nvm install` – it will activate proper Node.js version in your current command prompt session.
### Contribution Workflow
#### Github Codespaces
1. Click **Fork** above. It will automatically create a copy of this repository and add it to your account.
2. At the top of this page, select the branch you want to work on.
3. Click on "Code". Select the "Codespaces" submenu and click on "Create codespace on **branch name**".
4. Run `npm install`. Then run `npm run hot`: it will open a popup containing the editor, so make sure to disable your adblock if you're using one.
1. Click **Fork** above. It will automatically create a copy of this repository and add it to your account.
2. Clone the repository to your computer.
3. Open the folder in command prompt and run **`npm install`**