diff --git a/README.md b/README.md new file mode 100644 index 0000000..296cb39 --- /dev/null +++ b/README.md @@ -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