Create README.md

This commit is contained in:
Joshua Seigler 2019-05-07 13:32:35 -04:00 committed by GitHub
parent f87f5c4f18
commit 0f46cb32ac
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

32
README.md Normal file
View file

@ -0,0 +1,32 @@
# bl3skills.com
Repo for a BL3 skill planner
### Windows - everything you need:
You can install the prerequisites any way you want, but I recommend using [Chocolatey](https://chocolatey.org/).
You'll need a tool called `git` which manages software versions.
Open a command prompt and enter `choco install git`
I don't use Windows, I think you might have to use an Administrator command prompt.
You'll need a code editor. I suggest Visual Studio Code:
`choco install vscode`
This project is built with a Javascript tool called Node. You need Node Package Manager, aka npm:
`choco install npm`
To download this source code, in a command prompt in the folder you want to use, run
`git clone "https://github.com/seigler/bl3skills.com.git"`
Install the Node dependencies with `npm install`
Start the project with `npm run watch`
Open the project folder in Visual Studio Code and make whatever changes you want. The project should update along with your changes.
#### Resources:
How to use Git: https://www.codecademy.com/learn/learn-git
How to build a React project (Preact is very very similar to React): https://www.codecademy.com/learn/react-101
Preact documentation: https://preactjs.com/
PWA.cafe documentation: https://github.com/lukeed/pwa